{
  "openapi": "3.1.0",
  "info": {
    "title": "AdaptGroup Cloud API",
    "version": "4.6.0",
    "description": "Cloud API lets your backend sell and manage VPS, dedicated rentals and additional IPv4 from an integration balance.\n\nBase URL: **https://cloud-api.adaptgroup.pro**. Authenticate every request with `X-Api-Key` and the integration's `api_key_id` in the documented query or JSON body. RU and EN describe the same API; locale in mail login links selects the mail interface language.\n\nAmounts are decimal strings in USD. Plan prices already include your integration markup; extra VPS traffic and IPv4 use fixed prices. Quote endpoints calculate without charging or reserving capacity.\n\nStart with [Quick start](./quick-start) and [Purchases and lifecycle](./purchase-flow). [Webhooks](./webhooks) describe order results, service events and expiry warnings.\n\n[OpenAPI (English)](/openapi/cloud.json) · [OpenAPI (Russian)](/openapi/cloud.ru.json)\n\nIP access is configured in the dashboard under **IP allowlist**. An empty list permits requests from any IP; otherwise the client must match an allowed IPv4/IPv6 address or CIDR subnet. A valid API key is always required. Requests outside the list return HTTP 403 with `detail.code=ip_not_allowed`. Dashboard access and outbound webhooks are unaffected."
  },
  "paths": {
    "/balance": {
      "get": {
        "tags": [
          "Balance"
        ],
        "summary": "Balance",
        "operationId": "check-balance",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BalanceCheckResponse"
                },
                "example": {
                  "success": true,
                  "api_key_id": 1,
                  "balance": "100.0000",
                  "currency": "USD",
                  "balance_updated_at": null
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns the integration balance in USD. Fields are at the top level, without a data wrapper.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/dedicated/rentals/quote": {
      "post": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "Calculate dedicated server price",
        "operationId": "quote-rental",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RentalCreateRequest"
              },
              "examples": {
                "standard": {
                  "summary": "Shared layout",
                  "value": {
                    "api_key_id": 1,
                    "months": 1,
                    "api_user_id": "customer-123",
                    "plan_id": 1,
                    "os_id": 1,
                    "disk_layout": "separate",
                    "extra_ipv4_count": 0,
                    "auto_renew": false,
                    "password": "Example-Password-2026!"
                  }
                },
                "storage": {
                  "summary": "Storage: disk groups",
                  "value": {
                    "api_key_id": 1,
                    "months": 1,
                    "api_user_id": "customer-123",
                    "plan_id": 2,
                    "os_id": 1,
                    "extra_ipv4_count": 0,
                    "auto_renew": false,
                    "password": "Example-Password-2026!",
                    "disk_layouts": {
                      "94dc1d25-4d4f-4c6b-a8e3-a226f66254a1": "raid1",
                      "dc8c3bfe-021d-4d40-adbe-55784a0b71e2": "raid6"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TermQuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "5.0000",
                    "balance_usd": "100.0000",
                    "currency": "USD",
                    "months": 1,
                    "discount_percent": "0"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Supply exactly one format: disk_layout for a shared-layout plan, or disk_layouts for a disk-group plan. disk_layouts maps the catalog disks[].id values to supported layout codes for those groups. Include every group and no extra keys. IDs are opaque: do not derive them from disk types. The client selects defaults; the API does not fill them in. Preserve the selection when retrying an order.\n\nChoose plan_id from the dedicated catalog. The platform chooses the physical server. Supply exactly one password or SSH public key, also for quotes. extra_ipv4_count adds addresses to this rental at a fixed price. A completed purchase order confirms reservation; wait for dedicated.issued / rental status active before handing the server to your customer. The term starts when issued.\n\nThis calculation creates no order, charge or reservation. It can be called with an insufficient balance. Use amount_usd as expected_amount_usd when confirming the purchase.\n\nHDD groups support RAID 5 (at least 3 disks), RAID 6 (at least 4) and RAID 10 (an even number of at least 4), when listed among the group options. These options are unavailable for other disk types and shared layouts.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/dedicated/rentals/{rental_id}/renew/quote": {
      "post": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "Calculate rental renewal",
        "operationId": "quote-rental-renewal",
        "parameters": [
          {
            "name": "rental_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Rental Id"
            },
            "description": "rental_id parameter.",
            "example": 201
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmRenewBody"
              },
              "example": {
                "api_key_id": 1,
                "months": 1
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TermQuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "5.0000",
                    "balance_usd": "100.0000",
                    "currency": "USD",
                    "months": 1,
                    "discount_percent": "0"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Extends an issued rental at current prices and discounts for the selected term. Additional IPv4 included in the rental are charged at the fixed price. Renewal is possible while active or overdue, before cleanup starts.\n\nThis calculation creates no order, charge or reservation. It can be called with an insufficient balance. Use amount_usd as expected_amount_usd when confirming the purchase.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/dedicated/plans": {
      "get": {
        "tags": [
          "Catalog"
        ],
        "summary": "Dedicated server plans",
        "operationId": "list-dedicated-plans",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "location_id",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "integer",
                  "maximum": 9223372036854775807,
                  "minimum": 1
                },
                {
                  "type": "null"
                }
              ],
              "title": "Location Id"
            },
            "description": "location_id parameter.",
            "example": 1
          },
          {
            "name": "platform",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "epyc",
                    "ryzen",
                    "xeon",
                    "storage"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Platform"
            },
            "description": "platform parameter.",
            "example": "epyc"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "default": 100,
              "title": "Limit"
            },
            "description": "Maximum number of records in this page.",
            "example": 25
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 2147483647,
              "minimum": 0,
              "default": 0,
              "title": "Offset"
            },
            "description": "Number of records to skip, starting from zero.",
            "example": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DedicatedPlansResponse"
                },
                "examples": {
                  "standard": {
                    "summary": "Shared layout",
                    "value": {
                      "success": true,
                      "data": [
                        {
                          "id": 1,
                          "code": "C1",
                          "name": "Example",
                          "platform": "epyc",
                          "cpu_model": "example",
                          "cpu_count": 1,
                          "cpu_cores": 1,
                          "cpu_threads": 1,
                          "ram_gb": 1,
                          "ram_description": null,
                          "disks": [
                            {
                              "count": 1,
                              "size_gb": 1,
                              "type": "example",
                              "model": null
                            }
                          ],
                          "disk_layouts": [
                            {
                              "code": "separate",
                              "name": "No Raid"
                            }
                          ],
                          "default_disk_layout": "separate",
                          "port_mbps": 1,
                          "traffic_tb": null,
                          "included_ipv4": 1,
                          "ipv6_prefix_length": null,
                          "location_id": 1,
                          "location_name": "Poland",
                          "country_code": "PL",
                          "datacenter": null,
                          "monthly_price_usd": "5.0000",
                          "extra_ipv4_monthly_price_usd": "5.0000",
                          "extra_traffic_tb_price_usd": "5.0000",
                          "term_discounts": {},
                          "available": 1,
                          "city": "Gdańsk"
                        }
                      ],
                      "total_count": 1,
                      "currency": "USD",
                      "updated_at": null
                    }
                  },
                  "storage": {
                    "summary": "Storage: disk groups",
                    "value": {
                      "success": true,
                      "data": [
                        {
                          "id": 2,
                          "code": "STORAGE-E2244G",
                          "name": "Storage E-2244G",
                          "platform": "storage",
                          "cpu_model": "Intel Xeon E-2244G",
                          "cpu_count": 1,
                          "cpu_cores": 4,
                          "cpu_threads": 8,
                          "ram_gb": 64,
                          "ram_description": null,
                          "disks": [
                            {
                              "id": "94dc1d25-4d4f-4c6b-a8e3-a226f66254a1",
                              "count": 2,
                              "size_gb": 500,
                              "type": "nvme",
                              "model": null,
                              "disk_layouts": [
                                {
                                  "code": "separate",
                                  "name": "No Raid"
                                },
                                {
                                  "code": "lvm_linear",
                                  "name": "LVM (combined disks)"
                                },
                                {
                                  "code": "raid0",
                                  "name": "RAID 0"
                                },
                                {
                                  "code": "raid1",
                                  "name": "RAID 1"
                                }
                              ],
                              "default_disk_layout": "separate"
                            },
                            {
                              "id": "dc8c3bfe-021d-4d40-adbe-55784a0b71e2",
                              "count": 4,
                              "size_gb": 18000,
                              "type": "hdd",
                              "model": null,
                              "disk_layouts": [
                                {
                                  "code": "separate",
                                  "name": "No Raid"
                                },
                                {
                                  "code": "lvm_linear",
                                  "name": "LVM (combined disks)"
                                },
                                {
                                  "code": "raid0",
                                  "name": "RAID 0"
                                },
                                {
                                  "code": "raid1",
                                  "name": "RAID 1"
                                },
                                {
                                  "code": "raid5",
                                  "name": "RAID 5"
                                },
                                {
                                  "code": "raid6",
                                  "name": "RAID 6"
                                },
                                {
                                  "code": "raid10",
                                  "name": "RAID 10"
                                }
                              ],
                              "default_disk_layout": "separate"
                            }
                          ],
                          "disk_layouts": [],
                          "default_disk_layout": null,
                          "port_mbps": 10000,
                          "traffic_tb": "50",
                          "included_ipv4": 1,
                          "ipv6_prefix_length": null,
                          "location_id": 1,
                          "location_name": "Poland",
                          "country_code": "PL",
                          "datacenter": null,
                          "monthly_price_usd": "212.5000",
                          "extra_ipv4_monthly_price_usd": "5.0000",
                          "extra_traffic_tb_price_usd": "5.0000",
                          "term_discounts": {
                            "1": "0",
                            "3": "3",
                            "6": "5",
                            "12": "8",
                            "24": "10",
                            "36": "12"
                          },
                          "available": 1,
                          "city": "Gdańsk"
                        }
                      ],
                      "total_count": 1,
                      "currency": "USD",
                      "updated_at": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "For disk-group plans (including Storage), each disks[] entry contains id, disk_layouts with code/name, and default_disk_layout. Top-level disk_layouts is empty and default_disk_layout is null. Submit a disk_layouts object keyed by group IDs. For other plans, use the top-level options and a disk_layout string. separate is displayed as No Raid. Availability does not reserve a server. Server prices include markup; extra IPv4 and traffic prices are fixed. term_discounts contains term discounts.\n\nHDD groups support RAID 5 (at least 3 disks), RAID 6 (at least 4) and RAID 10 (an even number of at least 4), when listed among the group options. These options are unavailable for other disk types and shared layouts.\n\ndata[].city contains the location city without localization, including Storage plans.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/dedicated/rentals": {
      "post": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "Rent a dedicated server",
        "operationId": "create-rental",
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RentalCreateRequest"
              },
              "examples": {
                "standard": {
                  "summary": "Shared layout",
                  "value": {
                    "api_key_id": 1,
                    "months": 1,
                    "api_user_id": "customer-123",
                    "plan_id": 1,
                    "os_id": 1,
                    "disk_layout": "separate",
                    "extra_ipv4_count": 0,
                    "auto_renew": false,
                    "password": "Example-Password-2026!"
                  }
                },
                "storage": {
                  "summary": "Storage: disk groups",
                  "value": {
                    "api_key_id": 1,
                    "months": 1,
                    "api_user_id": "customer-123",
                    "plan_id": 2,
                    "os_id": 1,
                    "extra_ipv4_count": 0,
                    "auto_renew": false,
                    "password": "Example-Password-2026!",
                    "disk_layouts": {
                      "94dc1d25-4d4f-4c6b-a8e3-a226f66254a1": "raid1",
                      "dc8c3bfe-021d-4d40-adbe-55784a0b71e2": "raid6"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "5.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Supply exactly one format: disk_layout for a shared-layout plan, or disk_layouts for a disk-group plan. disk_layouts maps the catalog disks[].id values to supported layout codes for those groups. Include every group and no extra keys. IDs are opaque: do not derive them from disk types. The client selects defaults; the API does not fill them in. Preserve the selection when retrying an order.\n\nChoose plan_id from the dedicated catalog. The platform chooses the physical server. Supply exactly one password or SSH public key, also for quotes. extra_ipv4_count adds addresses to this rental at a fixed price. A completed purchase order confirms reservation; wait for dedicated.issued / rental status active before handing the server to your customer. The term starts when issued.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\nHDD groups support RAID 5 (at least 3 disks), RAID 6 (at least 4) and RAID 10 (an even number of at least 4), when listed among the group options. These options are unavailable for other disk types and shared layouts.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      },
      "get": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "List rentals",
        "operationId": "list-rentals",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "api_user_id",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 255,
                  "pattern": "\\S"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Api User Id"
            },
            "description": "Your customer identifier. Stored as a string; scoped to this integration.",
            "example": "customer-123"
          },
          {
            "name": "location_id",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "integer",
                  "maximum": 9223372036854775807,
                  "minimum": 1
                },
                {
                  "type": "null"
                }
              ],
              "title": "Location Id"
            },
            "description": "location_id parameter.",
            "example": 1
          },
          {
            "name": "platform",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "epyc",
                    "ryzen",
                    "xeon",
                    "storage"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Platform"
            },
            "description": "platform parameter.",
            "example": "epyc"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "preparing",
                    "active",
                    "overdue",
                    "cleaning",
                    "completed",
                    "cancelled"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Status"
            },
            "description": "status parameter.",
            "example": "preparing"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "default": 25,
              "title": "Limit"
            },
            "description": "Maximum number of records in this page.",
            "example": 25
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 2147483647,
              "minimum": 0,
              "default": 0,
              "title": "Offset"
            },
            "description": "Number of records to skip, starting from zero.",
            "example": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RentalListResponse"
                },
                "examples": {
                  "standard": {
                    "summary": "Shared layout",
                    "value": {
                      "success": true,
                      "data": [
                        {
                          "id": 1,
                          "api_user_id": "customer-123",
                          "order_id": 401,
                          "status": "preparing",
                          "plan": {
                            "id": 1,
                            "code": "C1",
                            "name": "Example",
                            "platform": "epyc",
                            "cpu_model": "example",
                            "cpu_count": 1,
                            "cpu_cores": 1,
                            "cpu_threads": 1,
                            "ram_gb": 1,
                            "ram_description": null,
                            "disks": [
                              {
                                "count": 1,
                                "size_gb": 1,
                                "type": "example",
                                "model": null
                              }
                            ],
                            "disk_layouts": [
                              "separate"
                            ],
                            "default_disk_layout": "separate",
                            "port_mbps": 1,
                            "traffic_tb": null,
                            "included_ipv4": 1,
                            "ipv6_prefix_length": null
                          },
                          "location_id": 1,
                          "location_name": "Poland",
                          "country_code": "PL",
                          "datacenter": null,
                          "os": "debian-12",
                          "hostname": null,
                          "disk_layout": "separate",
                          "term_months": 1,
                          "extra_ipv4_count": 1,
                          "auto_renew": false,
                          "issued_at": null,
                          "paid_until": null,
                          "overdue_at": null,
                          "finished_at": null,
                          "created_at": "2026-09-28T12:00:00Z"
                        }
                      ],
                      "total_count": 1
                    }
                  },
                  "storage": {
                    "summary": "Storage: disk groups",
                    "value": {
                      "success": true,
                      "data": [
                        {
                          "id": 1,
                          "api_user_id": "customer-123",
                          "order_id": 401,
                          "status": "preparing",
                          "plan": {
                            "id": 2,
                            "code": "STORAGE-E2244G",
                            "name": "Storage E-2244G",
                            "platform": "storage",
                            "cpu_model": "Intel Xeon E-2244G",
                            "cpu_count": 1,
                            "cpu_cores": 4,
                            "cpu_threads": 8,
                            "ram_gb": 64,
                            "ram_description": null,
                            "disks": [
                              {
                                "count": 2,
                                "size_gb": 500,
                                "type": "nvme",
                                "model": null,
                                "id": "94dc1d25-4d4f-4c6b-a8e3-a226f66254a1",
                                "disk_layouts": [
                                  "separate",
                                  "lvm_linear",
                                  "raid0",
                                  "raid1"
                                ],
                                "default_disk_layout": "separate"
                              },
                              {
                                "count": 4,
                                "size_gb": 18000,
                                "type": "hdd",
                                "model": null,
                                "id": "dc8c3bfe-021d-4d40-adbe-55784a0b71e2",
                                "disk_layouts": [
                                  "separate",
                                  "lvm_linear",
                                  "raid0",
                                  "raid1",
                                  "raid5",
                                  "raid6",
                                  "raid10"
                                ],
                                "default_disk_layout": "separate"
                              }
                            ],
                            "disk_layouts": [
                              "separate"
                            ],
                            "default_disk_layout": "separate",
                            "port_mbps": 10000,
                            "traffic_tb": "50",
                            "included_ipv4": 1,
                            "ipv6_prefix_length": null
                          },
                          "location_id": 1,
                          "location_name": "Poland",
                          "country_code": "PL",
                          "datacenter": null,
                          "os": "debian-12",
                          "hostname": null,
                          "disk_layout": null,
                          "term_months": 1,
                          "extra_ipv4_count": 1,
                          "auto_renew": false,
                          "issued_at": null,
                          "paid_until": null,
                          "overdue_at": null,
                          "finished_at": null,
                          "created_at": "2026-09-28T12:00:00Z",
                          "disk_layouts": {
                            "94dc1d25-4d4f-4c6b-a8e3-a226f66254a1": "raid1",
                            "dc8c3bfe-021d-4d40-adbe-55784a0b71e2": "raid6"
                          }
                        }
                      ],
                      "total_count": 1
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Lists rentals owned by this integration with customer, location, platform and status filters. Credentials are available only in rental details.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/dedicated/rentals/{rental_id}/renew": {
      "post": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "Renew rental",
        "operationId": "renew-rental",
        "parameters": [
          {
            "name": "rental_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Rental Id"
            },
            "description": "rental_id parameter.",
            "example": 201
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmRenewBody"
              },
              "example": {
                "api_key_id": 1,
                "months": 1
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "5.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Extends an issued rental at current prices and discounts for the selected term. Additional IPv4 included in the rental are charged at the fixed price. Renewal is possible while active or overdue, before cleanup starts.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/dedicated/rentals/{rental_id}": {
      "patch": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "Rental auto-renewal",
        "operationId": "set-rental-auto-renew",
        "parameters": [
          {
            "name": "rental_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Rental Id"
            },
            "description": "rental_id parameter.",
            "example": 201
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AutoRenewBody"
              },
              "example": {
                "api_key_id": 1,
                "auto_renew": false
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RentalAutoRenewResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "rental_id": 201,
                    "auto_renew": false
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Changes the auto-renewal setting without charging the balance or extending the paid term. The default is false. See the lifecycle guide for renewal timing, duration and pricing.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      },
      "get": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "Rental details and credentials",
        "operationId": "get-rental",
        "parameters": [
          {
            "name": "rental_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Rental Id"
            },
            "description": "rental_id parameter.",
            "example": 201
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RentalResponse"
                },
                "examples": {
                  "standard": {
                    "summary": "Shared layout",
                    "value": {
                      "success": true,
                      "data": {
                        "id": 1,
                        "api_user_id": "customer-123",
                        "order_id": 401,
                        "status": "preparing",
                        "plan": {
                          "id": 1,
                          "code": "C1",
                          "name": "Example",
                          "platform": "epyc",
                          "cpu_model": "example",
                          "cpu_count": 1,
                          "cpu_cores": 1,
                          "cpu_threads": 1,
                          "ram_gb": 1,
                          "ram_description": null,
                          "disks": [
                            {
                              "count": 1,
                              "size_gb": 1,
                              "type": "example",
                              "model": null
                            }
                          ],
                          "disk_layouts": [
                            "separate"
                          ],
                          "default_disk_layout": "separate",
                          "port_mbps": 1,
                          "traffic_tb": null,
                          "included_ipv4": 1,
                          "ipv6_prefix_length": null
                        },
                        "location_id": 1,
                        "location_name": "Poland",
                        "country_code": "PL",
                        "datacenter": null,
                        "os": "debian-12",
                        "hostname": null,
                        "disk_layout": "separate",
                        "term_months": 1,
                        "extra_ipv4_count": 1,
                        "auto_renew": false,
                        "issued_at": null,
                        "paid_until": null,
                        "overdue_at": null,
                        "finished_at": null,
                        "created_at": "2026-09-28T12:00:00Z",
                        "host": null,
                        "login": "root",
                        "password": null,
                        "ssh_public_key": null,
                        "ips": [
                          {
                            "id": 1,
                            "address": "192.0.2.10",
                            "is_primary": true
                          }
                        ]
                      }
                    }
                  },
                  "storage": {
                    "summary": "Storage: disk groups",
                    "value": {
                      "success": true,
                      "data": {
                        "id": 1,
                        "api_user_id": "customer-123",
                        "order_id": 401,
                        "status": "preparing",
                        "plan": {
                          "id": 2,
                          "code": "STORAGE-E2244G",
                          "name": "Storage E-2244G",
                          "platform": "storage",
                          "cpu_model": "Intel Xeon E-2244G",
                          "cpu_count": 1,
                          "cpu_cores": 4,
                          "cpu_threads": 8,
                          "ram_gb": 64,
                          "ram_description": null,
                          "disks": [
                            {
                              "count": 2,
                              "size_gb": 500,
                              "type": "nvme",
                              "model": null,
                              "id": "94dc1d25-4d4f-4c6b-a8e3-a226f66254a1",
                              "disk_layouts": [
                                "separate",
                                "lvm_linear",
                                "raid0",
                                "raid1"
                              ],
                              "default_disk_layout": "separate"
                            },
                            {
                              "count": 4,
                              "size_gb": 18000,
                              "type": "hdd",
                              "model": null,
                              "id": "dc8c3bfe-021d-4d40-adbe-55784a0b71e2",
                              "disk_layouts": [
                                "separate",
                                "lvm_linear",
                                "raid0",
                                "raid1",
                                "raid5",
                                "raid6",
                                "raid10"
                              ],
                              "default_disk_layout": "separate"
                            }
                          ],
                          "disk_layouts": [
                            "separate"
                          ],
                          "default_disk_layout": "separate",
                          "port_mbps": 10000,
                          "traffic_tb": "50",
                          "included_ipv4": 1,
                          "ipv6_prefix_length": null
                        },
                        "location_id": 1,
                        "location_name": "Poland",
                        "country_code": "PL",
                        "datacenter": null,
                        "os": "debian-12",
                        "hostname": null,
                        "disk_layout": null,
                        "term_months": 1,
                        "extra_ipv4_count": 1,
                        "auto_renew": false,
                        "issued_at": null,
                        "paid_until": null,
                        "overdue_at": null,
                        "finished_at": null,
                        "created_at": "2026-09-28T12:00:00Z",
                        "host": null,
                        "login": "root",
                        "password": null,
                        "ssh_public_key": null,
                        "ips": [
                          {
                            "id": 1,
                            "address": "192.0.2.10",
                            "is_primary": true
                          }
                        ],
                        "disk_layouts": {
                          "94dc1d25-4d4f-4c6b-a8e3-a226f66254a1": "raid1",
                          "dc8c3bfe-021d-4d40-adbe-55784a0b71e2": "raid6"
                        }
                      }
                    }
                  }
                }
              }
            },
            "headers": {
              "Cache-Control": {
                "schema": {
                  "type": "string",
                  "const": "no-store"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns rental hardware, payment term, status and access credentials. Credentials may be null before issue. Cache-Control: no-store. preparing is preparation; active is issued; overdue is unpaid; cleaning is release/cleanup; completed and cancelled are terminal states.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/plans": {
      "get": {
        "tags": [
          "Catalog"
        ],
        "summary": "VPS plans and availability",
        "operationId": "list-plans",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "cpu_percent",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "multipleOf": 20,
              "maximum": 100,
              "minimum": 20,
              "default": 60,
              "title": "Cpu Percent"
            },
            "description": "CPU share: 20, 40, 60, 80 or 100. Creation defaults to 60; resize keeps the current share if omitted.",
            "example": 60
          },
          {
            "name": "location_id",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "integer",
                  "maximum": 9223372036854775807,
                  "minimum": 1
                },
                {
                  "type": "null"
                }
              ],
              "title": "Location Id"
            },
            "description": "location_id parameter.",
            "example": 1
          },
          {
            "name": "platform",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "epyc",
                    "ryzen",
                    "xeon"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Platform"
            },
            "description": "platform parameter.",
            "example": "epyc"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PlansListResponse"
                },
                "example": {
                  "success": true,
                  "api_key_id": 1,
                  "cpu_percent": 60,
                  "currency": "USD",
                  "locations": [
                    {
                      "id": 1,
                      "name": "Example",
                      "country_code": "PL",
                      "datacenter": null,
                      "platforms": [
                        {
                          "platform": "epyc",
                          "cpu_display_name": "AMD EPYC",
                          "availability_updated_at": null,
                          "plans": [
                            {
                              "code": "A1",
                              "name": "A1",
                              "cpu_cores": 1,
                              "ram_mb": 1024,
                              "disk_gb": 20,
                              "traffic_tb": "5.0000",
                              "monthly_price_usd": "5.0000",
                              "available": null,
                              "automatic_backup_monthly_price_usd": "1.0000"
                            }
                          ],
                          "term_discounts": {
                            "1": "0",
                            "3": "3",
                            "6": "5",
                            "12": "8",
                            "24": "10",
                            "36": "12"
                          },
                          "extra_ipv4_monthly_price_usd": "2.0000",
                          "extra_traffic_tb_price_usd": "1.0000",
                          "cpu_max_frequency_ghz": null
                        }
                      ],
                      "city": "Gdańsk"
                    }
                  ],
                  "manual_backup_gb_month_price_usd": "0.050000"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "VPS plan prices already include your integration markup. cpu_percent defaults to 60; supported values: 20, 40, 60, 80, 100. Availability is a snapshot, not a reservation. available=null means unknown, not zero. \n\nlocations[].city contains the location city without localization. locations[].platforms[].term_discounts contains current discounts shared by the plans in that location/platform: keys are term lengths in months as strings (1, 3, 6, 12, 24, 36), and values are percentages serialized as strings. Availability may differ for cpu_percent=20/40/60/80/100; the default is 60. available=null means unknown availability, not zero. Confirm the final purchase total with the quotation endpoint: calculating it from the rounded monthly catalog price may differ from the quote.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nEach locations[].platforms[] entry also includes extra_ipv4_monthly_price_usd (monthly rate for one IPv4; both standalone and VPS add-on rentals use calendar months) and extra_traffic_tb_price_usd (1 TB = 1024^4 bytes). These are fixed prices without integration markup, CPU factor or term discount, serialized as USD strings with four decimal places. They are available before VPS creation. Use the corresponding quote route to confirm the current price before purchase.\n\nEach plan includes automatic_backup_monthly_price_usd. Monthly USD price for this plan’s automatic backups: backups are daily and the latest 7 backups are retained. Price covers the entire package, not each copy; no integration markup, CPU factor or term discount. String with four decimal places. The top-level manual_backup_gb_month_price_usd contains the shared manual backup rate. Shared USD rate per GiB of stored manual backup per month (1 GiB = 1073741824 bytes). Manual backups are made on an existing VPS. This is a storage rate, not the total price per copy or per GiB of the VPS disk. No markup or term discount. String with six decimal places. Manage backup services through /backup-services and /backups; see [Backups](./backups).\n\nChoose a CPU family before purchase: epyc — AMD EPYC, ryzen — AMD Ryzen, xeon — Intel Xeon. Different models of the same family may be used within a location. cpu_display_name is the family name; cpu_max_frequency_ghz is null because the exact model and frequency are determined after provisioning."
      }
    },
    "/reference/os": {
      "get": {
        "tags": [
          "Catalog"
        ],
        "summary": "Operating systems",
        "operationId": "list-os",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OsListResponse"
                },
                "example": {
                  "success": true,
                  "os": [
                    {
                      "id": 1,
                      "code": "debian-12",
                      "name": "Debian 12",
                      "logo_url": "https://cdn.example.com/os/debian.svg"
                    },
                    {
                      "id": 2,
                      "code": "ubuntu-24.04",
                      "name": "Ubuntu 24.04",
                      "logo_url": null
                    }
                  ]
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Use the returned numeric os_id for purchases and reinstalls. code identifies the OS template; name is its display name. logo_url is the OS image URL, or null if no image is configured.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nWindows images, when enabled, appear in this same catalog with id, code, name and logo_url. Codes include windows-10, windows-11, windows-server-2019-eval, windows-server-2022-eval and windows-server-2025-eval. Use the current catalog; a listed image does not guarantee capacity or template availability in every location."
      }
    },
    "/reference/applications": {
      "get": {
        "tags": [
          "Catalog"
        ],
        "summary": "Applications",
        "operationId": "list-applications",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationsResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": 1,
                      "app_code": "wordpress",
                      "category": "websites",
                      "name": "WordPress",
                      "variant": "",
                      "version": null,
                      "logo_url": "https://cdn.example.com/app/wordpress.svg",
                      "documentation_url": null,
                      "supported_os": [
                        "ubuntu-24.04"
                      ],
                      "recommended_os": "ubuntu-24.04",
                      "min_cpu_cores": 1,
                      "min_ram_mb": 1024,
                      "min_disk_gb": 20,
                      "recommended_cpu_cores": 2,
                      "recommended_ram_mb": 2048,
                      "recommended_disk_gb": 40,
                      "requirements_source_urls": [],
                      "installation_mode": "cloud_init"
                    }
                  ],
                  "total": 1
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Active applications for VPS creation. Select a numeric id and pass it as application_id together with os_id. Group variants by app_code; category is a single category code, name is the display name, variant and version distinguish editions. An empty variant is the ordinary edition; version may be null. supported_os and recommended_os contain OS codes from the OS catalog. min_* describes known minimum resources; null means unspecified. recommended_* describes a starting configuration, not guaranteed application capacity. RAM is in MiB and disk is in GiB. logo_url is the image URL; documentation_url may be null. requirements_source_urls lists requirement sources. The installer and cloud-init contents are not exposed.\n\ninstallation_mode is cloud_init or background. For background applications, VPS issue and billing start before the application finishes installing. guest_initialization.status=succeeded only confirms base cloud-init completion; there is no separate application-ready webhook. Check adapt-application-install.service inside the VPS. Application setup, domains, tokens or licences may still be required."
      }
    },
    "/vms/{vm_id}/firewall": {
      "get": {
        "tags": [
          "Firewall"
        ],
        "summary": "Firewall settings",
        "operationId": "get-firewall",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmFirewallResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "vm_id": 101,
                    "revision": 0,
                    "applied": true,
                    "input_policy": "ACCEPT",
                    "output_policy": "ACCEPT",
                    "rules": [
                      {
                        "direction": "IN",
                        "action": "ACCEPT",
                        "protocol": "tcp",
                        "ports": [
                          "443"
                        ],
                        "source": null,
                        "destination": null,
                        "enabled": true,
                        "comment": "HTTPS",
                        "id": 1
                      }
                    ],
                    "smtp_ports": [
                      1
                    ],
                    "smtp_blocked": true
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Read the current revision before any change and send it back. A conflict requires rereading settings before a new command. Rule order matters; reorder must contain every rule ID exactly once. PUT replaces the full rule. position is zero-based. At most 100 rules; ports are strings such as \"443\" or \"8000-8010\" and apply only to TCP/UDP. Source/destination accept an IP or CIDR of matching IP versions. Use the separate [PATCH /vms/{vm_id}/firewall/smtp](./set-firewall-smtp) endpoint to open or close SMTP ports.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/firewall/rules": {
      "post": {
        "tags": [
          "Firewall"
        ],
        "summary": "Add rule",
        "operationId": "add-firewall-rule",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FirewallAddBody"
              },
              "example": {
                "api_key_id": 1,
                "revision": 0,
                "rule": {
                  "direction": "IN",
                  "action": "ACCEPT",
                  "protocol": "tcp",
                  "ports": [
                    "443"
                  ],
                  "source": null,
                  "destination": null,
                  "enabled": true,
                  "comment": "HTTPS"
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Read the current revision before any change and send it back. A conflict requires rereading settings before a new command. Rule order matters; reorder must contain every rule ID exactly once. PUT replaces the full rule. position is zero-based. At most 100 rules; ports are strings such as \"443\" or \"8000-8010\" and apply only to TCP/UDP. Source/destination accept an IP or CIDR of matching IP versions. Use the separate [PATCH /vms/{vm_id}/firewall/smtp](./set-firewall-smtp) endpoint to open or close SMTP ports.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/firewall/rules/{rule_id}": {
      "put": {
        "tags": [
          "Firewall"
        ],
        "summary": "Replace rule",
        "operationId": "update-firewall-rule",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "rule_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Rule Id"
            },
            "description": "rule_id parameter.",
            "example": 1
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FirewallUpdateBody"
              },
              "example": {
                "api_key_id": 1,
                "revision": 0,
                "rule": {
                  "direction": "IN",
                  "action": "ACCEPT",
                  "protocol": "tcp",
                  "ports": [
                    "443"
                  ],
                  "source": null,
                  "destination": null,
                  "enabled": true,
                  "comment": "HTTPS"
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Read the current revision before any change and send it back. A conflict requires rereading settings before a new command. Rule order matters; reorder must contain every rule ID exactly once. PUT replaces the full rule. position is zero-based. At most 100 rules; ports are strings such as \"443\" or \"8000-8010\" and apply only to TCP/UDP. Source/destination accept an IP or CIDR of matching IP versions. Use the separate [PATCH /vms/{vm_id}/firewall/smtp](./set-firewall-smtp) endpoint to open or close SMTP ports.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      },
      "delete": {
        "tags": [
          "Firewall"
        ],
        "summary": "Delete rule",
        "operationId": "delete-firewall-rule",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "rule_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Rule Id"
            },
            "description": "rule_id parameter.",
            "example": 1
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "revision",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 0,
              "title": "Revision"
            },
            "description": "Current firewall revision from GET firewall. Reread on conflict.",
            "example": 0
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Read the current revision before any change and send it back. A conflict requires rereading settings before a new command. Rule order matters; reorder must contain every rule ID exactly once. PUT replaces the full rule. position is zero-based. At most 100 rules; ports are strings such as \"443\" or \"8000-8010\" and apply only to TCP/UDP. Source/destination accept an IP or CIDR of matching IP versions. Use the separate [PATCH /vms/{vm_id}/firewall/smtp](./set-firewall-smtp) endpoint to open or close SMTP ports.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/firewall/order": {
      "put": {
        "tags": [
          "Firewall"
        ],
        "summary": "Reorder rules",
        "operationId": "reorder-firewall-rules",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FirewallReorderBody"
              },
              "example": {
                "api_key_id": 1,
                "revision": 0,
                "rule_ids": [
                  1,
                  2
                ]
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Read the current revision before any change and send it back. A conflict requires rereading settings before a new command. Rule order matters; reorder must contain every rule ID exactly once. PUT replaces the full rule. position is zero-based. At most 100 rules; ports are strings such as \"443\" or \"8000-8010\" and apply only to TCP/UDP. Source/destination accept an IP or CIDR of matching IP versions. Use the separate [PATCH /vms/{vm_id}/firewall/smtp](./set-firewall-smtp) endpoint to open or close SMTP ports.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/firewall/policies": {
      "patch": {
        "tags": [
          "Firewall"
        ],
        "summary": "Default policies",
        "operationId": "set-firewall-policies",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FirewallPoliciesBody"
              },
              "example": {
                "api_key_id": 1,
                "revision": 0,
                "input_policy": "ACCEPT",
                "output_policy": "ACCEPT"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Read the current revision before any change and send it back. A conflict requires rereading settings before a new command. Rule order matters; reorder must contain every rule ID exactly once. PUT replaces the full rule. position is zero-based. At most 100 rules; ports are strings such as \"443\" or \"8000-8010\" and apply only to TCP/UDP. Source/destination accept an IP or CIDR of matching IP versions. Use the separate [PATCH /vms/{vm_id}/firewall/smtp](./set-firewall-smtp) endpoint to open or close SMTP ports.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/quote": {
      "post": {
        "tags": [
          "VPS billing"
        ],
        "summary": "Calculate VPS price",
        "operationId": "quote-vm",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmCreateRequest"
              },
              "examples": {
                "application": {
                  "summary": "Application",
                  "value": {
                    "api_key_id": 1,
                    "api_user_id": "customer-123",
                    "location_id": 1,
                    "platform": "epyc",
                    "plan_code": "C1",
                    "cpu_percent": 60,
                    "os_id": 1,
                    "months": 1,
                    "auto_renew": false,
                    "password": "Example-Password-2026!",
                    "application_id": 1
                  }
                },
                "cloud_init": {
                  "summary": "Custom cloud-init",
                  "value": {
                    "api_key_id": 1,
                    "api_user_id": "customer-123",
                    "location_id": 1,
                    "platform": "epyc",
                    "plan_code": "C1",
                    "cpu_percent": 60,
                    "os_id": 1,
                    "months": 1,
                    "auto_renew": false,
                    "password": "Example-Password-2026!",
                    "cloud_init": {
                      "packages": [
                        "curl"
                      ],
                      "runcmd": [
                        [
                          "sh",
                          "-c",
                          "echo ready > /root/cloud-init-ready"
                        ]
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TermQuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "5.0000",
                    "balance_usd": "100.0000",
                    "currency": "USD",
                    "months": 1,
                    "discount_percent": "0"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Choose a plan, location and OS from the catalog. For a normal installation, supply exactly one of password or ssh_public_key, including in the quote request. The SSH key is a single OpenSSH public-key line (Ed25519, RSA or ECDSA). cpu_percent defaults to 60, months to 1 and auto_renew to false. api_user_id is your own customer identifier.\n\nThis calculation creates no order, charge or reservation. It can be called with an insufficient balance. Use amount_usd as expected_amount_usd when confirming the purchase.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nOptional cloud-config JSON object, not a YAML string. Maximum 65536 bytes after server JSON serialization (non-ASCII characters are escaped). users, packages, runcmd and write_files must be arrays when present. Networking, hostname and primary access are managed by the platform. Retain the same object when retrying. Its result is reported separately in guest_initialization; cloud_init contents are not returned in orders or webhooks.\n\nLatest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health.\n\nOptional application_id selects an application from GET /reference/applications. Keep os_id and exactly one access method. Do not combine application_id with a non-null cloud_init, including {}. Availability, OS and resource compatibility are checked during provisioning by the server service; Cloud API does not duplicate those checks. A rejected creation is handled by the existing order refund flow. Quotes calculate the VPS price only and do not confirm application compatibility. Applications do not add a separate charge. Keep application_id unchanged when retrying the same Idempotency-Key.\n\nWindows VPS use the same endpoint and an os_id from GET /reference/os. New Windows installations use login admin; Linux uses root. Windows requires password (8–127 characters, at least three of lowercase, uppercase, digits and special characters; no CR, LF or NUL and no login substring). Do not supply ssh_public_key, application_id or non-null cloud_init, including {}. A Windows hostname must be at most 15 characters and cannot contain only digits. OS/template/resource compatibility is checked by the server service during provisioning; a quote does not confirm it. Rejected creation follows the existing order refund flow.\n\nTo create a new VPS from a paid backup, supply backup_id instead of os_id. Omit password, ssh_public_key, application_id and cloud_init: OS, programs and access come from the copy. Keep the same api_user_id as the backup owner. The new VPS receives its own addresses and is billed as a normal vm_purchase with the usual plan markup and term discount. Restore itself has no separate fee and shares the 3-per-service/24-hour restore limit. The selected disk must fit all backed-up disks; compatibility is checked by the server service."
      }
    },
    "/vms/{vm_id}/renew/quote": {
      "post": {
        "tags": [
          "VPS billing"
        ],
        "summary": "Calculate VPS renewal",
        "operationId": "quote-vm-renewal",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmRenewBody"
              },
              "example": {
                "api_key_id": 1,
                "months": 1
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TermQuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "5.0000",
                    "balance_usd": "100.0000",
                    "currency": "USD",
                    "months": 1,
                    "discount_percent": "0"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Adds the selected number of calendar months to the current paid term, or starts from the current time if it has expired. Uses current prices, markup and term discount. Renew before the service is deleted.\n\nThis calculation creates no order, charge or reservation. It can be called with an insufficient balance. Use amount_usd as expected_amount_usd when confirming the purchase.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/resize/quote": {
      "post": {
        "tags": [
          "VPS billing"
        ],
        "summary": "Calculate plan upgrade",
        "operationId": "quote-vm-resize",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmResizeBody"
              },
              "example": {
                "api_key_id": 1,
                "plan_code": "C1"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResizeQuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "5.0000",
                    "balance_usd": "100.0000",
                    "currency": "USD",
                    "vm_id": 101,
                    "new_monthly_price_usd": "10.0000",
                    "paid_until": "2026-09-28T12:00:00Z"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Only upgrades are supported: CPU resources, RAM, disk and included traffic cannot decrease. Omit cpu_percent to keep the current share. The surcharge covers the remaining paid calendar periods at current plan prices with their originally purchased term discounts. paid_until does not change. expected_amount_usd is the maximum accepted surcharge, since it may decrease with time.\n\nThis calculation creates no order, charge or reservation. It can be called with an insufficient balance. Use amount_usd as expected_amount_usd when confirming the purchase.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/traffic/topup/quote": {
      "post": {
        "tags": [
          "VPS billing"
        ],
        "summary": "Calculate extra traffic",
        "operationId": "quote-traffic",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmTrafficTopupBody"
              },
              "example": {
                "api_key_id": 1,
                "traffic_tb": 1
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrafficQuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "5.0000",
                    "balance_usd": "100.0000",
                    "currency": "USD",
                    "vm_id": 101,
                    "unit_price_usd": "1.0000",
                    "expected_period_id": 601,
                    "period_ends_at": "2026-09-28T12:00:00Z"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "traffic_tb is an integer; one unit is 1099511627776 bytes (1024⁴). Extra traffic has a fixed price without integration markup and applies only to the current traffic period. Copy expected_period_id from the quote into the purchase to detect a period change (409 quote_expired).\n\nThis calculation creates no order, charge or reservation. It can be called with an insufficient balance. Use amount_usd as expected_amount_usd when confirming the purchase.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/ips/quote": {
      "post": {
        "tags": [
          "IP addresses"
        ],
        "summary": "Calculate IPv4 purchase",
        "operationId": "quote-ip",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmIpv4PurchaseBody"
              },
              "example": {
                "api_key_id": 1,
                "auto_renew": false,
                "months": 1
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Ipv4QuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "5.0000",
                    "balance_usd": "100.0000",
                    "currency": "USD",
                    "vm_id": 101,
                    "months": 1,
                    "monthly_price_usd": "5.0000"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Buys one extra IPv4 for months=1/3/6/12/24/36 calendar months (default 1) and attaches it to this VPS. Price is the fixed monthly rate times months, without integration markup or term discount. Its payment term and auto-renewal are independent of the VPS. A VPS can have at most 10 IPv4 including the primary address.\n\nThis calculation creates no order, charge or reservation. It can be called with an insufficient balance. Use amount_usd as expected_amount_usd when confirming the purchase.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/password/reset": {
      "post": {
        "tags": [
          "VPS management"
        ],
        "summary": "Reset password",
        "operationId": "reset-vm-password",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PasswordResetBody"
              },
              "example": {
                "api_key_id": 1,
                "login": "root",
                "password": "Example-Password-2026!"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Changes the password of an existing OS user through the guest agent. If login is omitted or null, the actual installation login is used (normally admin for Windows and root for Linux). If that login is unknown, HTTP 409 with code vm_login_required asks for an explicit login. An explicitly supplied login is preserved. Windows password policy is enforced by the guest OS. A working guest agent is required. A failed or unconfirmed operation does not prove the password remained unchanged: check access before another command.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/reinstall": {
      "post": {
        "tags": [
          "VPS management"
        ],
        "summary": "Reinstall OS",
        "operationId": "reinstall-vm",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReinstallBody"
              },
              "example": {
                "api_key_id": 1,
                "os_id": 1,
                "wipe_extra_disks": false,
                "password": "Example-Password-2026!",
                "cloud_init": {
                  "packages": [
                    "curl"
                  ],
                  "runcmd": [
                    [
                      "sh",
                      "-c",
                      "echo ready > /root/cloud-init-ready"
                    ]
                  ]
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Recreates the system disk and destroys its data. Extra disks are kept unless wipe_extra_disks=true. Supply either a password or SSH public key; omit both to reuse the installation access settings. Both together are invalid. VPS identity, network and paid term are preserved.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nOptional cloud-config JSON object, not a YAML string. Maximum 65536 bytes after server JSON serialization (non-ASCII characters are escaped). users, packages, runcmd and write_files must be arrays when present. Networking, hostname and primary access are managed by the platform. Retain the same object when retrying. Its result is reported separately in guest_initialization; cloud_init contents are not returned in orders or webhooks.\n\nLatest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health.\n\nWithout an explicit cloud_init, reinstallation retains the saved application and exact installer snapshot. The server service checks that the new OS is compatible. Explicit cloud_init, including {}, replaces the application; application becomes null after successful reinstallation. Selecting a different application_id on reinstall is not supported.\n\nWindows reinstallation uses this same endpoint. The installation login is retained; read it from GET /vms/{vm_id}. Omitted credentials reuse the saved installation access. Windows requires a valid password and does not support SSH keys, Linux applications or custom cloud_init. The existing VPS must have a compatible boot configuration and sufficient disk space; changing an arbitrary Linux VPS to Windows is not guaranteed. Compatibility is checked by the server service. The operation can fail with template_incompatible; check its final status."
      }
    },
    "/vms/{vm_id}/ips/{ip_id}": {
      "delete": {
        "tags": [
          "IP addresses"
        ],
        "summary": "Detach IPv4",
        "operationId": "detach-ip",
        "parameters": [
          {
            "name": "ip_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Ip Id"
            },
            "description": "ip_id parameter.",
            "example": 301
          },
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "keep_ip",
            "in": "query",
            "required": true,
            "schema": {
              "type": "boolean",
              "title": "Keep Ip"
            },
            "description": "Keep the detached IPv4 with continuing billing (true) or release it (false).",
            "example": true
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Detaches an extra IPv4; the primary address cannot be detached. keep_ip is required in query: true keeps the address with continuing separate billing, false releases it. Check guest_configuration_required and adjust guest networking when required. Unused time is not refunded.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      },
      "put": {
        "tags": [
          "IP addresses"
        ],
        "summary": "Attach saved IPv4",
        "operationId": "attach-ip",
        "parameters": [
          {
            "name": "ip_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Ip Id"
            },
            "description": "ip_id parameter.",
            "example": 301
          },
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Attaches an available, paid saved IPv4 to a compatible VPS without a new purchase or term change. api_key_id is in query; no JSON body. Check guest_configuration_required: network configuration inside the guest may need updating.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}": {
      "delete": {
        "tags": [
          "VPS management"
        ],
        "summary": "Delete VPS",
        "operationId": "delete-vm",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "keep_ips",
            "in": "query",
            "required": true,
            "schema": {
              "type": "boolean",
              "title": "Keep Ips"
            },
            "description": "Explicitly retain IPv4 as separately billed addresses (true) or release them (false).",
            "example": true
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Permanently deletes the VPS. keep_ips is a required query parameter. true retains IPv4 addresses, including the primary address, as separately billed addresses; false releases them. The result contains held_ips. Unused VPS time is not refunded.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      },
      "patch": {
        "tags": [
          "VPS billing"
        ],
        "summary": "VPS auto-renewal",
        "operationId": "set-vm-auto-renew",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AutoRenewBody"
              },
              "example": {
                "api_key_id": 1,
                "auto_renew": false
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmAutoRenewResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "vm_id": 101,
                    "auto_renew": false
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Changes the auto-renewal setting without charging the balance or extending the paid term. The default is false. See the lifecycle guide for renewal timing, duration and pricing.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      },
      "get": {
        "tags": [
          "VPS management"
        ],
        "summary": "VPS details",
        "operationId": "get-vm",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmGetResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "name": "Example",
                    "hostname": "customer-vps",
                    "status": "example",
                    "cpu_cores": 1,
                    "cpu_percent": 60,
                    "ram_mb": 1,
                    "disk_gb": 1,
                    "smtp_blocked": true,
                    "paid_until": null,
                    "created_at": "2026-09-28T12:00:00Z",
                    "updated_at": null,
                    "ips": [
                      {
                        "ip_id": 301,
                        "address": "192.0.2.10",
                        "family": 4,
                        "is_rf_blocked": true,
                        "assigned_at": null,
                        "is_primary": true,
                        "paid_until": null,
                        "suspended_at": null,
                        "auto_renew": null
                      }
                    ],
                    "auto_renew": false,
                    "api_user_id": "customer-123",
                    "plan_code": "C1",
                    "platform": "epyc",
                    "cpu_display_name": "AMD EPYC 7502P",
                    "location_id": 1,
                    "location_name": "Poland",
                    "country_code": "PL",
                    "datacenter": null,
                    "city": "example",
                    "os": null,
                    "guest_initialization": {
                      "status": "succeeded",
                      "error_code": null
                    },
                    "rescue": {
                      "active": false,
                      "access": null,
                      "requires_review": false,
                      "operation_id": null,
                      "operation_status": null
                    },
                    "login": "root",
                    "cpu_max_frequency_ghz": 3.35
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns resources, location, OS, addresses, payment term and auto-renewal. Original VPS passwords and SSH keys are not returned.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nLatest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health.\n\nRescue state. active means a saved Rescue context, not guaranteed SSH availability. access is ssh, console or null. requires_review calls for state verification; operation_id and operation_status refer to the Rescue operation. null means no state was returned.\n\nApplication snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation.\n\nlogin is the actual installation user, normally admin for Windows or root for Linux; null means the login is unknown. Passwords are not returned.\n\nplatform, cpu_display_name and cpu_max_frequency_ghz describe the physical CPU of the VPS current node and can be null when unknown. After migration, subsequent list/detail requests reflect the new node. cpu_display_name is the stored model text and may include physical core/thread counts; allocated VPS resources are defined by cpu_cores. Maximum frequency is CPU metadata, not a live measurement or a guaranteed frequency per vCPU. Read these fields from VPS lists/details, not creation events or operation results.\n\nAdministrative blocks: admin_blocked_at and admin_block_reason are separate from status. Renewal does not unblock or start the server. Restrictions and errors: [administrative blocks](./quick-start#administrative-blocks)."
      }
    },
    "/vms": {
      "post": {
        "tags": [
          "VPS billing"
        ],
        "summary": "Buy a VPS",
        "operationId": "create-vm",
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmCreateRequest"
              },
              "examples": {
                "application": {
                  "summary": "Application",
                  "value": {
                    "api_key_id": 1,
                    "api_user_id": "customer-123",
                    "location_id": 1,
                    "platform": "epyc",
                    "plan_code": "C1",
                    "cpu_percent": 60,
                    "os_id": 1,
                    "months": 1,
                    "auto_renew": false,
                    "password": "Example-Password-2026!",
                    "application_id": 1
                  }
                },
                "cloud_init": {
                  "summary": "Custom cloud-init",
                  "value": {
                    "api_key_id": 1,
                    "api_user_id": "customer-123",
                    "location_id": 1,
                    "platform": "epyc",
                    "plan_code": "C1",
                    "cpu_percent": 60,
                    "os_id": 1,
                    "months": 1,
                    "auto_renew": false,
                    "password": "Example-Password-2026!",
                    "cloud_init": {
                      "packages": [
                        "curl"
                      ],
                      "runcmd": [
                        [
                          "sh",
                          "-c",
                          "echo ready > /root/cloud-init-ready"
                        ]
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "5.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "429": {
            "description": "Rolling 24-hour operation limit reached",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "backup_limit_reached",
                    "message": "Достигнут лимит операций бекапов за 24 часа"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Choose a plan, location and OS from the catalog. For a normal installation, supply exactly one of password or ssh_public_key, including in the quote request. The SSH key is a single OpenSSH public-key line (Ed25519, RSA or ECDSA). cpu_percent defaults to 60, months to 1 and auto_renew to false. api_user_id is your own customer identifier.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nOptional cloud-config JSON object, not a YAML string. Maximum 65536 bytes after server JSON serialization (non-ASCII characters are escaped). users, packages, runcmd and write_files must be arrays when present. Networking, hostname and primary access are managed by the platform. Retain the same object when retrying. Its result is reported separately in guest_initialization; cloud_init contents are not returned in orders or webhooks.\n\nLatest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health.\n\nWhen resources are unavailable, the order remains processing while waiting for provisioning. Read or cancel its queue at /orders/{order_id}/queue. After issue, order parameters.paid_until is updated from the actual creation result; before issue this date is provisional.\n\nOptional application_id selects an application from GET /reference/applications. Keep os_id and exactly one access method. Do not combine application_id with a non-null cloud_init, including {}. Availability, OS and resource compatibility are checked during provisioning by the server service; Cloud API does not duplicate those checks. A rejected creation is handled by the existing order refund flow. Quotes calculate the VPS price only and do not confirm application compatibility. Applications do not add a separate charge. Keep application_id unchanged when retrying the same Idempotency-Key.\n\nWindows VPS use the same endpoint and an os_id from GET /reference/os. New Windows installations use login admin; Linux uses root. Windows requires password (8–127 characters, at least three of lowercase, uppercase, digits and special characters; no CR, LF or NUL and no login substring). Do not supply ssh_public_key, application_id or non-null cloud_init, including {}. A Windows hostname must be at most 15 characters and cannot contain only digits. OS/template/resource compatibility is checked by the server service during provisioning; a quote does not confirm it. Rejected creation follows the existing order refund flow.\n\nTo create a new VPS from a paid backup, supply backup_id instead of os_id. Omit password, ssh_public_key, application_id and cloud_init: OS, programs and access come from the copy. Keep the same api_user_id as the backup owner. The new VPS receives its own addresses and is billed as a normal vm_purchase with the usual plan markup and term discount. Restore itself has no separate fee and shares the 3-per-service/24-hour restore limit. The selected disk must fit all backed-up disks; compatibility is checked by the server service.\n\nAdministrative blocks: admin_blocked_at and admin_block_reason are separate from status. Renewal does not unblock or start the server. Restrictions and errors: [administrative blocks](./quick-start#administrative-blocks)."
      },
      "get": {
        "tags": [
          "VPS management"
        ],
        "summary": "List VPS",
        "operationId": "list-vms",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "api_user_id",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 255,
                  "pattern": "\\S"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Api User Id"
            },
            "description": "Your customer identifier. Stored as a string; scoped to this integration.",
            "example": "customer-123"
          },
          {
            "name": "location_id",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "integer",
                  "maximum": 9223372036854775807,
                  "minimum": 1
                },
                {
                  "type": "null"
                }
              ],
              "title": "Location Id"
            },
            "description": "location_id parameter.",
            "example": 1
          },
          {
            "name": "platform",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "epyc",
                    "ryzen",
                    "xeon"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Platform"
            },
            "description": "Filter by the CPU family of the current node.",
            "example": "epyc"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "creating",
                    "stopped",
                    "running",
                    "migrating",
                    "deleting",
                    "deleted",
                    "error"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Status"
            },
            "description": "status parameter.",
            "example": "creating"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "default": 25,
              "title": "Limit"
            },
            "description": "Maximum number of records in this page.",
            "example": 25
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 2147483647,
              "minimum": 0,
              "default": 0,
              "title": "Offset"
            },
            "description": "Number of records to skip, starting from zero.",
            "example": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmListResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": 1,
                      "api_user_id": "customer-123",
                      "name": "Example",
                      "status": "example",
                      "plan_code": "C1",
                      "cpu_cores": 1,
                      "cpu_percent": 60,
                      "ram_mb": 1,
                      "disk_gb": 1,
                      "location_id": 1,
                      "location_name": "Poland",
                      "country_code": "PL",
                      "datacenter": null,
                      "platform": "epyc",
                      "ips": [
                        "example"
                      ],
                      "paid_until": null,
                      "auto_renew": false,
                      "cpu_display_name": "AMD EPYC 7502P",
                      "cpu_max_frequency_ghz": 3.35
                    }
                  ],
                  "total_count": 1
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Lists only VPS belonging to this integration. api_user_id filters by your customer identifier. total_count is the full filtered count, before limit/offset.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nApplication snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation.\n\nplatform, cpu_display_name and cpu_max_frequency_ghz describe the physical CPU of the VPS current node and can be null when unknown. After migration, subsequent list/detail requests reflect the new node. cpu_display_name is the stored model text and may include physical core/thread counts; allocated VPS resources are defined by cpu_cores. Maximum frequency is CPU metadata, not a live measurement or a guaranteed frequency per vCPU. Read these fields from VPS lists/details, not creation events or operation results.\n\nAdministrative blocks: admin_blocked_at and admin_block_reason are separate from status. Renewal does not unblock or start the server. Restrictions and errors: [administrative blocks](./quick-start#administrative-blocks). city, os_code and primary_ipv4 support resource cards without GET /vms/{vm_id}. The list reads persisted state from the database without polling Worker or Proxmox."
      }
    },
    "/vms/{vm_id}/renew": {
      "post": {
        "tags": [
          "VPS billing"
        ],
        "summary": "Renew a VPS",
        "operationId": "renew-vm",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmRenewBody"
              },
              "example": {
                "api_key_id": 1,
                "months": 1
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "5.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Adds the selected number of calendar months to the current paid term, or starts from the current time if it has expired. Uses current prices, markup and term discount. Renew before the service is deleted.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nAdministrative blocks: admin_blocked_at and admin_block_reason are separate from status. Renewal does not unblock or start the server. Restrictions and errors: [administrative blocks](./quick-start#administrative-blocks)."
      }
    },
    "/vms/{vm_id}/resize": {
      "post": {
        "tags": [
          "VPS billing"
        ],
        "summary": "Upgrade VPS plan",
        "operationId": "resize-vm",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmResizeBody"
              },
              "example": {
                "api_key_id": 1,
                "plan_code": "C1"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "5.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Only upgrades are supported: CPU resources, RAM, disk and included traffic cannot decrease. Omit cpu_percent to keep the current share. The surcharge covers the remaining paid calendar periods at current plan prices with their originally purchased term discounts. paid_until does not change. expected_amount_usd is the maximum accepted surcharge, since it may decrease with time.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/ips": {
      "post": {
        "tags": [
          "IP addresses"
        ],
        "summary": "Buy IPv4",
        "operationId": "buy-ip",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmIpv4PurchaseBody"
              },
              "example": {
                "api_key_id": 1,
                "auto_renew": false,
                "months": 1
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "5.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Buys one extra IPv4 for months=1/3/6/12/24/36 calendar months (default 1) and attaches it to this VPS. Price is the fixed monthly rate times months, without integration markup or term discount. Its payment term and auto-renewal are independent of the VPS. A VPS can have at most 10 IPv4 including the primary address.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/status": {
      "get": {
        "tags": [
          "VPS management"
        ],
        "summary": "Power status",
        "operationId": "get-vm-status",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmStatusResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "vm_id": 101,
                    "status": "example",
                    "uptime": 1
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns current power status and uptime in seconds.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/console/link": {
      "post": {
        "tags": [
          "VPS management"
        ],
        "summary": "Console link",
        "operationId": "create-console-link",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmConsoleLinkResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "vm_id": 101,
                    "url": "https://console.example.com/session/example",
                    "expires_at": "2026-09-28T12:00:00Z"
                  }
                }
              }
            },
            "headers": {
              "Cache-Control": {
                "schema": {
                  "type": "string",
                  "const": "no-store"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Creates a one-time console URL valid until expires_at. api_key_id is a query parameter; there is no JSON body or Idempotency-Key. The response uses Cache-Control: no-store.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nFor Windows this link opens the graphical desktop with keyboard and mouse support. Use this graphical console, not the serial terminal. This is not an RDP link."
      }
    },
    "/vms/{vm_id}/metrics": {
      "get": {
        "tags": [
          "VPS management"
        ],
        "summary": "Monitoring",
        "operationId": "get-vm-metrics",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "timeframe",
            "in": "query",
            "required": false,
            "schema": {
              "enum": [
                "hour",
                "day",
                "week",
                "month",
                "year"
              ],
              "type": "string",
              "default": "hour",
              "title": "Timeframe"
            },
            "description": "timeframe parameter.",
            "example": "hour"
          },
          {
            "name": "cf",
            "in": "query",
            "required": false,
            "schema": {
              "enum": [
                "AVERAGE",
                "MAX"
              ],
              "type": "string",
              "default": "AVERAGE",
              "title": "Cf"
            },
            "description": "cf parameter.",
            "example": "AVERAGE"
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmMetricsResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "vm_id": 101,
                    "timeframe": "hour",
                    "cf": "AVERAGE",
                    "points": [
                      {
                        "time": 1790596800,
                        "cpu_percent": null,
                        "memory_used_bytes": null,
                        "memory_total_bytes": null,
                        "network_in_mbps": null,
                        "network_out_mbps": null,
                        "disk_read_bytes_per_second": null,
                        "disk_write_bytes_per_second": null
                      }
                    ]
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Select the time range and aggregation (AVERAGE or MAX). A null metric means missing data, not zero. Point time is a Unix timestamp; network rates are Mbps, memory is bytes and disk rates are bytes/second.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/traffic": {
      "get": {
        "tags": [
          "VPS management"
        ],
        "summary": "Traffic usage",
        "operationId": "get-vm-traffic",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmTrafficResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "vm_id": 101,
                    "enabled": true,
                    "period": null,
                    "last_sample_at": null,
                    "shaping": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns the current traffic period, quota, usage and shaping. Byte counters and timestamps describe the last available sample. A missing period or shaping is represented as null.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/traffic/history": {
      "get": {
        "tags": [
          "VPS management"
        ],
        "summary": "Traffic history",
        "operationId": "get-vm-traffic-history",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmTrafficHistoryResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "vm_id": 101,
                    "days": [
                      {
                        "day": "2026-10-11",
                        "incoming_bytes": 1048576,
                        "outgoing_bytes": 2097152,
                        "estimated": false,
                        "updated_at": "2026-10-11T23:59:00Z"
                      },
                      {
                        "day": "2026-10-12",
                        "incoming_bytes": 524288,
                        "outgoing_bytes": 1048576,
                        "estimated": true,
                        "updated_at": "2026-10-12T01:00:00Z"
                      }
                    ]
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns all accumulated VPS incoming and outgoing traffic by UTC day, oldest first, without pagination. Counters are in bytes; outgoing traffic consumes the quota. The owner can read history after the VPS is deleted. If there are no observations yet, days is an empty array. Days without observations are omitted, and usage from before daily collection started is not backfilled.\n\nThe estimated=true flag means that usage from a sampling interval crossing UTC midnight was distributed between days in proportion to time. updated_at is the last update time for that day in UTC. The current day may be incomplete. The current quota and billing-period usage are available separately at GET /vms/{vm_id}/traffic.\n\n[Request rules and errors](./quick-start) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/traffic/topup": {
      "post": {
        "tags": [
          "VPS billing"
        ],
        "summary": "Buy extra traffic",
        "operationId": "buy-traffic",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmTrafficTopupBody"
              },
              "example": {
                "api_key_id": 1,
                "traffic_tb": 1
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "5.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "traffic_tb is an integer; one unit is 1099511627776 bytes (1024⁴). Extra traffic has a fixed price without integration markup and applies only to the current traffic period. Copy expected_period_id from the quote into the purchase to detect a period change (409 quote_expired).\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/power": {
      "post": {
        "tags": [
          "VPS management"
        ],
        "summary": "Power control",
        "operationId": "change-vm-power",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VmPowerBody"
              },
              "example": {
                "api_key_id": 1,
                "action": "start"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "admin_blocked": {
                    "value": {
                      "detail": {
                        "code": "vm_admin_blocked",
                        "message": "The server is blocked by an administrator. Contact support to unblock it",
                        "reason": "AUP violation"
                      }
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "start starts the VPS; shutdown and reboot request a graceful OS shutdown/reboot. stop forces power off; reset forces a restart and can lose unsaved data.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\nHTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nAdministrative blocks: admin_blocked_at and admin_block_reason are separate from status. Renewal does not unblock or start the server. Restrictions and errors: [administrative blocks](./quick-start#administrative-blocks)."
      }
    },
    "/vms/{vm_id}/operations": {
      "get": {
        "tags": [
          "VPS management"
        ],
        "summary": "Operation history",
        "operationId": "list-vm-operations",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "default": 20,
              "title": "Limit"
            },
            "description": "Maximum number of records in this page.",
            "example": 25
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 2147483647,
              "minimum": 0,
              "default": 0,
              "title": "Offset"
            },
            "description": "Number of records to skip, starting from zero.",
            "example": 0
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationListResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": 1,
                      "vm_id": 101,
                      "action": "start",
                      "status": "queued",
                      "created_at": "2026-09-28T12:00:00Z",
                      "started_at": null,
                      "finished_at": null,
                      "attempts": 1,
                      "order_id": null,
                      "power_action": null,
                      "requires_review": null,
                      "error_code": null,
                      "error_message": null
                    }
                  ],
                  "total_count": 1
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Operations and paid orders have different identifiers. Read data.id from a command response as operation_id. queued/running are not completion; succeeded/failed are terminal command results. History may also contain cancelled. result is populated only for successful delete, attach/detach, password reset and reinstall operations; use the status/firewall routes for other current state.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/operations/{operation_id}": {
      "get": {
        "tags": [
          "VPS management"
        ],
        "summary": "Operation result",
        "operationId": "get-vm-operation",
        "parameters": [
          {
            "name": "operation_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Operation Id"
            },
            "description": "operation_id parameter.",
            "example": 501
          },
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "power",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Operations and paid orders have different identifiers. Read data.id from a command response as operation_id. queued/running are not completion; succeeded/failed are terminal command results. History may also contain cancelled. result is populated only for successful delete, attach/detach, password reset and reinstall operations; use the status/firewall routes for other current state.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nLatest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health.\n\nRescue state. active means a saved Rescue context, not guaranteed SSH availability. access is ssh, console or null. requires_review calls for state verification; operation_id and operation_status refer to the Rescue operation. null means no state was returned."
      }
    },
    "/ips/{ip_id}": {
      "delete": {
        "tags": [
          "IP addresses"
        ],
        "summary": "Release saved IPv4",
        "operationId": "release-ip",
        "parameters": [
          {
            "name": "ip_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Ip Id"
            },
            "description": "ip_id parameter.",
            "example": 301
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IpReleaseResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "operation_id": 501,
                    "ip_id": 301,
                    "address": "192.0.2.10",
                    "family": 4,
                    "status": "released"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Permanently releases an unattached saved IPv4. The address must not be assigned to a VPS. No charge or refund is created. The result contains operation_id; HTTP 200 confirms release.\n\nSend a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      },
      "patch": {
        "tags": [
          "IP addresses"
        ],
        "summary": "IPv4 auto-renewal",
        "operationId": "set-ip-auto-renew",
        "parameters": [
          {
            "name": "ip_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Ip Id"
            },
            "description": "ip_id parameter.",
            "example": 301
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AutoRenewBody"
              },
              "example": {
                "api_key_id": 1,
                "auto_renew": false
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IpAutoRenewResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "ip_id": 301,
                    "auto_renew": false
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Changes the auto-renewal setting without charging the balance or extending the paid term. The default is false. See the lifecycle guide for renewal timing, duration and pricing.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/ips/{ip_id}/renew": {
      "post": {
        "tags": [
          "IP addresses"
        ],
        "summary": "Renew IPv4",
        "operationId": "renew-ip",
        "parameters": [
          {
            "name": "ip_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Ip Id"
            },
            "description": "ip_id parameter.",
            "example": 301
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IpRenewBody"
              },
              "example": {
                "api_key_id": 1
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IpRenewResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "completed",
                    "amount_usd": "5.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "error_code": null,
                    "error_message": null,
                    "ip_id": 301,
                    "paid_until": "2026-10-28T12:00:00Z"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Renews a separately paid IPv4 for months=1/3/6/12/24/36 calendar months from max(current time, paid_until). If omitted, months retains the last paid term. Price is the current monthly rate times the term, without markup or discount. The chosen term is also used by the next auto-renewal. Primary IPv4 and IPv6 cannot renew separately. Returns HTTP 200, a completed order and paid_until. Reuse the same Idempotency-Key and parameters after a lost response."
      }
    },
    "/ips": {
      "get": {
        "tags": [
          "IP addresses"
        ],
        "summary": "List IP addresses",
        "operationId": "list-ips",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "attachment",
            "in": "query",
            "required": false,
            "schema": {
              "enum": [
                "all",
                "attached",
                "unattached"
              ],
              "type": "string",
              "default": "all",
              "title": "Attachment"
            },
            "description": "all includes all addresses; unattached selects saved addresses without a VPS.",
            "example": "all"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "default": 25,
              "title": "Limit"
            },
            "description": "Maximum number of records in this page.",
            "example": 25
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 2147483647,
              "minimum": 0,
              "default": 0,
              "title": "Offset"
            },
            "description": "Number of records to skip, starting from zero.",
            "example": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IpListResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "ip_id": 301,
                      "address": "192.0.2.10",
                      "family": 4,
                      "api_user_id": "customer-123",
                      "vm_id": null,
                      "is_primary": true,
                      "location_id": 1,
                      "location_name": "Poland",
                      "country_code": "PL",
                      "paid_until": null,
                      "suspended_at": null,
                      "status": "active",
                      "auto_renew": null,
                      "monthly_price_usd": null,
                      "currency": "USD"
                    }
                  ],
                  "total_count": 1
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Includes attached and saved addresses. attachment=unattached selects saved addresses with vm_id=null. Only separately paid IPv4 have their own renewal price and auto-renewal; included primary IPv4 and IPv6 may have null billing fields. Prices are fixed, without markup.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      },
      "post": {
        "tags": [
          "IP addresses"
        ],
        "summary": "Rent IPv4 without a VPS",
        "operationId": "allocate-ip",
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IpPurchaseRequest"
              },
              "example": {
                "api_key_id": 1,
                "api_user_id": "customer-123",
                "location_id": 4,
                "months": 3,
                "auto_renew": false
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "4.5000",
                    "currency": "USD",
                    "vm_id": null,
                    "ip_id": null,
                    "paid_until": null,
                    "rental_id": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "One IPv4 in the selected location, without a VPS or cluster selection. Terms: 1/3/6/12/24/36 calendar months (default 1). Price is the fixed monthly rate from GET /plans times months, without markup or discount. The address belongs to api_user_id. auto_renew defaults to false; when enabled, renewals use the last paid term and current price.\n\nHTTP 202 accepts an ipv4_purchase order and charges its amount. Read GET /orders/{order_id}: completed orders include ip_id and paid_until, with vm_id=null. The address appears in GET /ips?attachment=unattached and can then be attached to a VPS of the same customer. Confirmed address exhaustion results in a refunded order. Events: order.completed and ip.allocated. After a lost response, retry the same Idempotency-Key and parameters. The paid term starts when the order is accepted."
      }
    },
    "/orders/{order_id}": {
      "get": {
        "tags": [
          "Orders"
        ],
        "summary": "Order details",
        "operationId": "get-order",
        "parameters": [
          {
            "name": "order_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Order Id"
            },
            "description": "order_id parameter.",
            "example": 401
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderDetailsResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "5.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "error_code": null,
                    "error_message": null,
                    "order_type": "vm_purchase",
                    "api_user_id": "customer-123",
                    "ip_id": null,
                    "created_at": "2026-09-28T12:00:00Z",
                    "updated_at": null,
                    "completed_at": null,
                    "parameters": {}
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Paid orders are separate from VPS operations. Statuses: pending, processing, completed, failed, refunded, review. completed on a dedicated purchase means reserved, not issued. review means an uncertain or partial outcome that needs clarification; do not start a duplicate purchase. Parameters expose only public fields and never passwords or internal costs.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nWhen resources are unavailable, the order remains processing while waiting for provisioning. Read or cancel its queue at /orders/{order_id}/queue. After issue, order parameters.paid_until is updated from the actual creation result; before issue this date is provisional.\n\nApplication snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation."
      }
    },
    "/orders": {
      "get": {
        "tags": [
          "Orders"
        ],
        "summary": "List orders",
        "operationId": "list-orders",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "api_user_id",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 255
                },
                {
                  "type": "null"
                }
              ],
              "title": "Api User Id"
            },
            "description": "Your customer identifier. Stored as a string; scoped to this integration.",
            "example": "customer-123"
          },
          {
            "name": "order_type",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "vm_purchase",
                    "vm_renewal",
                    "vm_resize",
                    "traffic_purchase",
                    "ipv4_purchase",
                    "ipv4_renewal",
                    "dedicated_purchase",
                    "dedicated_renewal",
                    "backup_purchase",
                    "backup_renewal",
                    "backup_service_delete",
                    "backup_delete",
                    "backup_restore",
                    "backup_export",
                    "mail_purchase",
                    "mail_renewal",
                    "mail_upgrade",
                    "mail_delete"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Order Type"
            },
            "description": "order_type parameter.",
            "example": "vm_purchase"
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "pending",
                    "processing",
                    "completed",
                    "failed",
                    "refunded",
                    "review"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Status"
            },
            "description": "status parameter.",
            "example": "pending"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "default": 50,
              "title": "Limit"
            },
            "description": "Maximum number of records in this page.",
            "example": 25
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 2147483647,
              "minimum": 0,
              "default": 0,
              "title": "Offset"
            },
            "description": "Number of records to skip, starting from zero.",
            "example": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderListResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "order_id": 401,
                      "status": "pending",
                      "amount_usd": "5.0000",
                      "currency": "USD",
                      "vm_id": null,
                      "rental_id": null,
                      "error_code": null,
                      "error_message": null,
                      "order_type": "vm_purchase",
                      "api_user_id": "customer-123",
                      "ip_id": null,
                      "created_at": "2026-09-28T12:00:00Z",
                      "updated_at": null,
                      "completed_at": null
                    }
                  ],
                  "total_count": 1
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Paid orders are separate from VPS operations. Statuses: pending, processing, completed, failed, refunded, review. completed on a dedicated purchase means reserved, not issued. review means an uncertain or partial outcome that needs clarification; do not start a duplicate purchase. Parameters expose only public fields and never passwords or internal costs.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nApplication snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation."
      }
    },
    "/transactions": {
      "get": {
        "tags": [
          "Balance"
        ],
        "summary": "Transaction history",
        "operationId": "list-transactions",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "transaction_type",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": [
                    "topup",
                    "vm_purchase",
                    "vm_renewal",
                    "vm_resize",
                    "traffic_purchase",
                    "ipv4_purchase",
                    "ipv4_renewal",
                    "dedicated_purchase",
                    "dedicated_renewal",
                    "backup_purchase",
                    "backup_renewal",
                    "refund",
                    "adjustment",
                    "mail_purchase",
                    "mail_renewal",
                    "mail_upgrade"
                  ],
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Transaction Type"
            },
            "description": "transaction_type parameter.",
            "example": "topup"
          },
          {
            "name": "order_id",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "integer",
                  "maximum": 9223372036854775807,
                  "minimum": 1
                },
                {
                  "type": "null"
                }
              ],
              "title": "Order Id"
            },
            "description": "order_id parameter.",
            "example": 401
          },
          {
            "name": "date_from",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "date"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Date From"
            },
            "description": "First included UTC date (YYYY-MM-DD).",
            "example": "2026-09-28"
          },
          {
            "name": "date_to",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "date"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Date To"
            },
            "description": "Last included UTC date (YYYY-MM-DD).",
            "example": "2026-09-28"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "default": 50,
              "title": "Limit"
            },
            "description": "Maximum number of records in this page.",
            "example": 25
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 2147483647,
              "minimum": 0,
              "default": 0,
              "title": "Offset"
            },
            "description": "Number of records to skip, starting from zero.",
            "example": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransactionListResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": 1,
                      "transaction_type": "topup",
                      "amount_usd": "5.0000",
                      "balance_before": "100.0000",
                      "balance_after": "95.0000",
                      "order_id": null,
                      "comment": null,
                      "created_at": "2026-09-28T12:00:00Z"
                    }
                  ],
                  "total_count": 1,
                  "currency": "USD",
                  "limit": 25,
                  "offset": 0
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns integration balance movements. amount_usd is signed: negative for a debit, positive for a credit. order_id may be null (for example a top-up). Date filters include the full UTC days. These are integration transactions, not organization transactions.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/vms/{vm_id}/rescue": {
      "put": {
        "tags": [
          "VPS management"
        ],
        "summary": "Enable Rescue",
        "operationId": "enable-vm-rescue",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RescueEnableBody"
              },
              "example": {
                "api_key_id": 1,
                "password": "Temporary-Rescue-2026!"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "rescue_enable",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Reboots the VPS into Rescue while preserving disks and networking. Requires at least 2048 MiB RAM and a paid VPS. Supply a temporary password; after success, connect as root to the VPS IP over SSH on port 22. Firewall rules still apply. Plan changes, OS reinstallation and normal OS password resets are unavailable in Rescue. Check the operation and rescue in VPS details. For rescue_not_ready or requires_review=true, verify the state and exit Rescue; retry a lost request with its original Idempotency-Key.\n\nHTTP 202 means acceptance. Poll GET /vms/{vm_id}/operations/{operation_id}; data.id is the operation ID. [Webhooks](./webhooks)."
      },
      "delete": {
        "tags": [
          "VPS management"
        ],
        "summary": "Disable Rescue",
        "operationId": "disable-vm-rescue",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "rescue_disable",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Exits Rescue and restores normal OS boot. A paid VPS is started; an expired or suspended VPS remains stopped. Exit is also allowed from error when Rescue context is saved. Send api_key_id in the query; no request body or password is needed. Use a separate Idempotency-Key for the exit command.\n\nHTTP 202 means acceptance. Poll GET /vms/{vm_id}/operations/{operation_id}; data.id is the operation ID. [Webhooks](./webhooks)."
      }
    },
    "/vms/{vm_id}/terminal/link": {
      "post": {
        "tags": [
          "VPS management"
        ],
        "summary": "Terminal link",
        "operationId": "create-terminal-link",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmConsoleLinkResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "vm_id": 101,
                    "url": "https://console.example.com/terminal/#token=example",
                    "expires_at": "2026-10-04T12:05:00Z"
                  }
                }
              }
            },
            "headers": {
              "Cache-Control": {
                "schema": {
                  "type": "string",
                  "const": "no-store"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Creates a one-time browser terminal URL for a running VPS, valid for five minutes before first use. Pass api_key_id in the query; no JSON body or Idempotency-Key. The response uses Cache-Control: no-store. Open the returned URL as is; it grants access to this VPS terminal.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)\n\nFor Windows desktop access use POST /vms/{vm_id}/console/link. This serial terminal does not provide a Windows desktop or an RDP connection."
      }
    },
    "/dedicated/rentals/{rental_id}/status": {
      "get": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "Dedicated server status",
        "operationId": "get-rental-status",
        "parameters": [
          {
            "name": "rental_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Rental Id"
            },
            "description": "rental_id parameter.",
            "example": 201
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RentalPowerStatusResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "rental_id": 201,
                    "power_state": "On",
                    "power_actions": [
                      "start",
                      "shutdown",
                      "stop",
                      "reset"
                    ],
                    "reinstall": true
                  }
                }
              }
            },
            "headers": {
              "Cache-Control": {
                "schema": {
                  "type": "string",
                  "const": "no-store"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns power_state, supported power_actions and the reinstall capability. Management is available only for an issued, active, paid rental on a server configured for it. Use power_actions instead of assuming all five commands are supported; unsupported commands are not replaced with a forced restart. On does not confirm OS or application readiness. Cache-Control: no-store.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/dedicated/rentals/{rental_id}/power": {
      "post": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "Dedicated server power",
        "operationId": "change-rental-power",
        "parameters": [
          {
            "name": "rental_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Rental Id"
            },
            "description": "rental_id parameter.",
            "example": 201
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "rental-action-20261004-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RentalPowerBody"
              },
              "example": {
                "api_key_id": 1,
                "action": "start"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RentalOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 301,
                    "rental_id": 201,
                    "action": "dedicated_power",
                    "status": "queued",
                    "created_at": "2026-10-04T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "result": null,
                    "requires_review": false,
                    "review_resolved_at": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Accepts start, shutdown, stop, reboot or reset. First read the supported power_actions from rental status. shutdown/reboot request a graceful shutdown/restart; stop/reset force it and can lose unsaved data. Returns an asynchronous operation, not a financial order; the integration balance is not charged. Only active, paid rentals with configured management can accept a new command.\n\nSend Idempotency-Key for each new command. After a lost response, retry the original key and unchanged body. HTTP 202 confirms acceptance; read the operation or webhook for the outcome.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/dedicated/rentals/{rental_id}/reinstall": {
      "post": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "Reinstall dedicated OS",
        "operationId": "reinstall-rental",
        "parameters": [
          {
            "name": "rental_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Rental Id"
            },
            "description": "rental_id parameter.",
            "example": 201
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "rental-action-20261004-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RentalReinstallBody"
              },
              "example": {
                "api_key_id": 1,
                "os_id": 11,
                "confirmed": true
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RentalOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 301,
                    "rental_id": 201,
                    "action": "dedicated_reinstall",
                    "status": "queued",
                    "created_at": "2026-10-04T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "result": null,
                    "requires_review": false,
                    "review_resolved_at": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Reinstalls the OS and erases server disks; confirmed: true is required. Use os_id from the OS directory. The server must support reinstall and the selected OS; hostname, login, disk layout, IP addresses, owner and paid term are retained. If password and ssh_public_key are both omitted, stored credentials are retained. If either field is supplied, the complete credential set is replaced; the omitted field is not retained. A password, a public SSH key or both may be supplied; an empty set is rejected. cloud_init is not supported here. The command does not charge the balance. After success, read rental details for current credentials; operations and webhooks do not contain them.\n\nSend Idempotency-Key for each new command. After a lost response, retry the original key and unchanged body. HTTP 202 confirms acceptance; read the operation or webhook for the outcome.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/dedicated/rentals/{rental_id}/operations": {
      "get": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "Dedicated operation history",
        "operationId": "list-rental-operations",
        "parameters": [
          {
            "name": "rental_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Rental Id"
            },
            "description": "rental_id parameter.",
            "example": 201
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "default": 50,
              "title": "Limit"
            },
            "description": "Maximum number of records in this page.",
            "example": 50
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 2147483647,
              "minimum": 0,
              "default": 0,
              "title": "Offset"
            },
            "description": "Number of records to skip, starting from zero.",
            "example": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RentalOperationListResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": 301,
                      "rental_id": 201,
                      "action": "dedicated_power",
                      "status": "queued",
                      "created_at": "2026-10-04T12:00:00Z",
                      "started_at": null,
                      "finished_at": null,
                      "result": null,
                      "requires_review": false,
                      "review_resolved_at": null,
                      "error_code": null,
                      "error_message": null
                    }
                  ],
                  "total_count": 1
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Lists power and reinstall operations for this rental, including after it has ended. Newest first; total_count is the count before pagination. A pending operation or an unresolved requires_review result blocks a new command. review_resolved_at records an administrator review; it does not rewrite the historical failed result.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/dedicated/rentals/{rental_id}/operations/{operation_id}": {
      "get": {
        "tags": [
          "Dedicated servers"
        ],
        "summary": "Dedicated operation",
        "operationId": "get-rental-operation",
        "parameters": [
          {
            "name": "rental_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Rental Id"
            },
            "description": "rental_id parameter.",
            "example": 201
          },
          {
            "name": "operation_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Operation Id"
            },
            "description": "operation_id parameter.",
            "example": 301
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RentalOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 301,
                    "rental_id": 201,
                    "action": "dedicated_power",
                    "status": "succeeded",
                    "created_at": "2026-10-04T12:00:00Z",
                    "started_at": "2026-10-04T12:00:01Z",
                    "finished_at": "2026-10-04T12:00:05Z",
                    "result": {
                      "power_state": "On",
                      "changed": true,
                      "power_action": "start"
                    },
                    "requires_review": false,
                    "review_resolved_at": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns the operation only when it belongs to the specified rental and integration. Status: queued, running, succeeded, failed or cancelled. Successful power result includes power_state, changed and optional power_action; reinstall result includes os and verified. verified confirms installation checks, not client application health. Failed operations expose a public error and requires_review. If requires_review is true and review_resolved_at is null, contact support before a new command; repeating the same Idempotency-Key returns the original operation.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow) · [Webhooks](./webhooks)"
      }
    },
    "/monitoring/locations/uptime": {
      "get": {
        "tags": [
          "Monitoring"
        ],
        "summary": "Locations uptime",
        "operationId": "list-locations-uptime",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "days",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/UptimeDays",
              "default": 30
            },
            "description": "Period in days: 1, 14, 30 or 90. Defaults to 30.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationsUptimeResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "days": 1,
                    "locations": [
                      {
                        "location_id": 1,
                        "location_name": "US — Fremont",
                        "uptime_percent": 99.8,
                        "coverage_percent": 100
                      },
                      {
                        "location_id": 3,
                        "location_name": "PL — Gdańsk",
                        "uptime_percent": null,
                        "coverage_percent": 0
                      }
                    ]
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Monitoring temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns brief uptime for active locations participating in VPS hosting monitoring. For a location chart, use GET /monitoring/locations/{location_id}/uptime.\n\nPeriods: 1/14/30/90 days, default 30. uptime_percent is the mean uptime of observed hosting nodes in the location, not a guarantee of availability for every VPS. coverage_percent describes observation coverage. Without observations uptime_percent=null; missing data means neither 100% uptime nor confirmed downtime. Maintenance and monitor errors are not counted as confirmed downtime.\n\nPoints are hourly for 1 day and daily UTC for other periods. The rolling window clips edge intervals: one day may contain 25 points and 30 days may contain 31. Timestamps are ISO 8601 strings in UTC. Node identifiers, names and internal parameters are not returned.\n\n[Request rules and errors](./quick-start)"
      }
    },
    "/monitoring/locations/{location_id}/uptime": {
      "get": {
        "tags": [
          "Monitoring"
        ],
        "summary": "Location uptime",
        "operationId": "get-location-uptime",
        "parameters": [
          {
            "name": "location_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Location Id"
            },
            "description": "Location ID from the locations uptime list.",
            "example": 1
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "days",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/UptimeDays",
              "default": 30
            },
            "description": "Period in days: 1, 14, 30 or 90. Defaults to 30.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationUptimeResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "location_id": 1,
                    "location_name": "US — Fremont",
                    "uptime_percent": 99.8,
                    "coverage_percent": 100,
                    "days": 1,
                    "from": "2026-10-11T00:00:00Z",
                    "to": "2026-10-12T00:00:00Z",
                    "points": [
                      {
                        "from": "2026-10-11T00:00:00Z",
                        "to": "2026-10-11T01:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T01:00:00Z",
                        "to": "2026-10-11T02:00:00Z",
                        "uptime_percent": 95.2,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T02:00:00Z",
                        "to": "2026-10-11T03:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T03:00:00Z",
                        "to": "2026-10-11T04:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T04:00:00Z",
                        "to": "2026-10-11T05:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T05:00:00Z",
                        "to": "2026-10-11T06:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T06:00:00Z",
                        "to": "2026-10-11T07:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T07:00:00Z",
                        "to": "2026-10-11T08:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T08:00:00Z",
                        "to": "2026-10-11T09:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T09:00:00Z",
                        "to": "2026-10-11T10:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T10:00:00Z",
                        "to": "2026-10-11T11:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T11:00:00Z",
                        "to": "2026-10-11T12:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T12:00:00Z",
                        "to": "2026-10-11T13:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T13:00:00Z",
                        "to": "2026-10-11T14:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T14:00:00Z",
                        "to": "2026-10-11T15:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T15:00:00Z",
                        "to": "2026-10-11T16:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T16:00:00Z",
                        "to": "2026-10-11T17:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T17:00:00Z",
                        "to": "2026-10-11T18:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T18:00:00Z",
                        "to": "2026-10-11T19:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T19:00:00Z",
                        "to": "2026-10-11T20:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T20:00:00Z",
                        "to": "2026-10-11T21:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T21:00:00Z",
                        "to": "2026-10-11T22:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T22:00:00Z",
                        "to": "2026-10-11T23:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T23:00:00Z",
                        "to": "2026-10-12T00:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      }
                    ]
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Location is absent from the available monitoring summary.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Monitoring temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns detailed uptime for the selected location with time-series points. A location absent from the monitoring summary returns 404.\n\nPeriods: 1/14/30/90 days, default 30. uptime_percent is the mean uptime of observed hosting nodes in the location, not a guarantee of availability for every VPS. coverage_percent describes observation coverage. Without observations uptime_percent=null; missing data means neither 100% uptime nor confirmed downtime. Maintenance and monitor errors are not counted as confirmed downtime.\n\nPoints are hourly for 1 day and daily UTC for other periods. The rolling window clips edge intervals: one day may contain 25 points and 30 days may contain 31. Timestamps are ISO 8601 strings in UTC. Node identifiers, names and internal parameters are not returned.\n\n[Request rules and errors](./quick-start)"
      }
    },
    "/vms/queue": {
      "get": {
        "tags": [
          "VPS billing"
        ],
        "summary": "VPS queue size",
        "operationId": "get-vm-queue-count",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "example": 1,
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          {
            "name": "platform",
            "in": "query",
            "required": true,
            "schema": {
              "enum": [
                "epyc",
                "ryzen",
                "xeon"
              ],
              "type": "string",
              "title": "Platform"
            },
            "example": "epyc"
          },
          {
            "name": "location_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Location Id"
            },
            "example": 3
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmQueueCountResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "location_id": 3,
                    "platform": "epyc",
                    "waiting": 4
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Result unconfirmed; retry the same request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns the total number of queued VPS purchases for the location and platform across all buyers, including bot purchases. Only a count is exposed. Values may be cached for up to five seconds. It is not a capacity guarantee or a delivery-time estimate."
      }
    },
    "/orders/{order_id}/queue": {
      "get": {
        "tags": [
          "Orders"
        ],
        "summary": "Order queue",
        "operationId": "get-order-queue",
        "parameters": [
          {
            "name": "order_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Order Id"
            },
            "example": 42
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "example": 1,
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderQueueResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 42,
                    "operation_id": 501,
                    "status": "queued",
                    "location_id": 3,
                    "platform": "epyc",
                    "waiting": 4,
                    "position": 2,
                    "reason": "node_unavailable",
                    "can_cancel": true,
                    "created_at": "2026-10-12T08:00:00Z"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Result unconfirmed; retry the same request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns the creation queue for a VPS purchase belonging to this integration. Use the Cloud API order_id, not operation_id. status is the provisioning operation status: queued, running, succeeded, failed or cancelled; it differs from the billing order status. position is the order position among waiting purchases in the location/platform, or null outside the queue. waiting is the total waiting count across buyers. Counts may lag by up to five seconds; placement can skip orders that do not fit currently available resources. can_cancel=true means cancellation was possible when read, not a reservation of that right. reason can be node_busy, node_unavailable, ip_pool_exhausted, network_pool_empty or null. Returns 409 queue_not_ready before the order reaches provisioning; check GET /orders/{order_id} and retry while the order is pending or processing. Non-VPS purchases return 409 not_vm_purchase."
      },
      "delete": {
        "tags": [
          "Orders"
        ],
        "summary": "Cancel VPS queue",
        "operationId": "cancel-order-queue",
        "parameters": [
          {
            "name": "order_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Order Id"
            },
            "example": 42
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "example": 1,
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "guest_initialization": null,
                    "order_id": 42,
                    "status": "refunded",
                    "amount_usd": "10.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "error_code": "creation_cancelled",
                    "error_message": "Создание сервера отменено до выдачи, оплата возвращена"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Result unconfirmed; retry the same request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Cancels a queued VPS purchase before resource reservation or provisioning starts. Use the Cloud API order_id. The request has no body; api_key_id is a query parameter. No Idempotency-Key is needed: repeating DELETE for the same cancelled order returns the refunded order without another refund. HTTP 200 confirms cancellation and refund of the original charged amount to the integration balance. A zero-cost administrative order remains zero-cost. The order status is refunded with error_code=creation_cancelled; provisioning status is cancelled. Expect order.refunded and vm.creation_cancelled webhooks. Once provisioning starts, returns 409 queue_cancel_unavailable without a refund. Before dispatch, returns 409 queue_not_ready; non-VPS purchases return 409 not_vm_purchase. A 503 response does not prove cancellation failed: read the order and repeat the same DELETE. This route does not delete an issued VPS or cancel a dedicated rental."
      }
    },
    "/vms/{vm_id}/node/uptime": {
      "get": {
        "tags": [
          "VPS management"
        ],
        "summary": "VPS node uptime",
        "operationId": "get-vm-node-uptime",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "days",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/UptimeDays",
              "default": 30
            },
            "description": "Period in days: 1, 14, 30 or 90. Defaults to 30.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmNodeUptimeResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "uptime_percent": 99.8,
                    "coverage_percent": 100,
                    "days": 1,
                    "from": "2026-10-11T00:00:00Z",
                    "to": "2026-10-12T00:00:00Z",
                    "points": [
                      {
                        "from": "2026-10-11T00:00:00Z",
                        "to": "2026-10-11T01:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T01:00:00Z",
                        "to": "2026-10-11T02:00:00Z",
                        "uptime_percent": 95.2,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T02:00:00Z",
                        "to": "2026-10-11T03:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T03:00:00Z",
                        "to": "2026-10-11T04:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T04:00:00Z",
                        "to": "2026-10-11T05:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T05:00:00Z",
                        "to": "2026-10-11T06:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T06:00:00Z",
                        "to": "2026-10-11T07:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T07:00:00Z",
                        "to": "2026-10-11T08:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T08:00:00Z",
                        "to": "2026-10-11T09:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T09:00:00Z",
                        "to": "2026-10-11T10:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T10:00:00Z",
                        "to": "2026-10-11T11:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T11:00:00Z",
                        "to": "2026-10-11T12:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T12:00:00Z",
                        "to": "2026-10-11T13:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T13:00:00Z",
                        "to": "2026-10-11T14:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T14:00:00Z",
                        "to": "2026-10-11T15:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T15:00:00Z",
                        "to": "2026-10-11T16:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T16:00:00Z",
                        "to": "2026-10-11T17:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T17:00:00Z",
                        "to": "2026-10-11T18:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T18:00:00Z",
                        "to": "2026-10-11T19:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T19:00:00Z",
                        "to": "2026-10-11T20:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T20:00:00Z",
                        "to": "2026-10-11T21:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T21:00:00Z",
                        "to": "2026-10-11T22:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T22:00:00Z",
                        "to": "2026-10-11T23:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      },
                      {
                        "from": "2026-10-11T23:00:00Z",
                        "to": "2026-10-12T00:00:00Z",
                        "uptime_percent": 100,
                        "coverage_percent": 100
                      }
                    ],
                    "vm_id": 101
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Monitoring temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns uptime of the node currently hosting this VPS. VPS ownership is verified; internal node IDs and names are not exposed. This is infrastructure availability, not guest OS uptime. After VM migration the response describes the new node.\n\nPeriods: 1/14/30/90 days, default 30. uptime_percent measures observed availability; coverage_percent measures observation coverage. With no observations uptime_percent is null. Points are hourly for 1 day and daily UTC otherwise; edge intervals are clipped. Timestamps use ISO 8601 UTC.\n\n[Request rules and errors](./quick-start)"
      }
    },
    "/vms/{vm_id}/backup-estimate": {
      "get": {
        "tags": [
          "Backups"
        ],
        "summary": "Estimate backup size",
        "operationId": "estimate-backup",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupEstimateResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns provisioned disk size and guest used bytes when available. stored_size_bytes is null: the exact billable size is known only after capture. This request does not create a backup or charge the balance."
      }
    },
    "/backup-services": {
      "post": {
        "tags": [
          "Backups"
        ],
        "summary": "Create backup service",
        "operationId": "create-backup-service",
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BackupCreateBody"
              },
              "example": {
                "api_key_id": 1,
                "vm_id": 101,
                "kind": "automatic",
                "auto_renew": false
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "1.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "backup_service_id": null,
                    "backup_id": null,
                    "worker_operation_id": null,
                    "guest_initialization": null,
                    "application": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Creates a separate automatic or manual storage service for an existing VPS. auto_renew defaults to false. Automatic service: the first copy is created on activation, then daily, retaining the latest 7 successful copies. One manual service stores one copy. The paid period is one calendar month; the final paid_until comes from service activation. Automatic storage is charged upfront using the plan price from GET /plans; failed creation is refunded. Manual storage is charged after capture: stored_size_bytes / 1073741824 × the rate captured at purchase, rounded to 4 USD decimals. Pending manual amount_usd is 0.0000, not a free service. If balance is insufficient, the copy is deleted; an integration allowed to have a negative balance is charged into the negative. Copies remain inaccessible until initial payment is confirmed. No integration markup, CPU factor or term discount.\n\nSend Idempotency-Key. HTTP 202 returns order_id; poll GET /orders/{order_id}. Acceptance is not completion. worker_operation_id appears after dispatch. Free actions are also recorded as zero-amount orders."
      },
      "get": {
        "tags": [
          "Backups"
        ],
        "summary": "List backup services",
        "operationId": "list-backup-services",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            }
          },
          {
            "name": "api_user_id",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 255
                },
                {
                  "type": "null"
                }
              ],
              "title": "Api User Id"
            }
          },
          {
            "name": "vm_id",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 1
                },
                {
                  "type": "null"
                }
              ],
              "title": "Vm Id"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "default": 25,
              "title": "Limit"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0,
              "title": "Offset"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupServicesResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Lists the integration’s non-deleted services, including services whose source VPS was deleted. Optional api_user_id and vm_id filters; total_count is the number matching the filters. Service status is storage status; check the purchase order to confirm billing."
      }
    },
    "/backup-services/{service_id}": {
      "get": {
        "tags": [
          "Backups"
        ],
        "summary": "Backup service details",
        "operationId": "get-backup-service",
        "parameters": [
          {
            "name": "service_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Service Id"
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupServiceResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns the owner, type, storage status, auto_renew and paid_until. The service survives deletion of the source VPS. After expiry there is a 24-hour renewal/restore grace period before deletion. Inspect the purchase order to confirm initial billing."
      },
      "patch": {
        "tags": [
          "Backups"
        ],
        "summary": "Set backup auto-renewal",
        "operationId": "set-backup-auto-renew",
        "parameters": [
          {
            "name": "service_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Service Id"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BackupAutoRenewBody"
              },
              "example": {
                "api_key_id": 1,
                "auto_renew": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupServiceResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Enables or disables renewal from the integration balance. Does not change the current paid period or refund it. Auto-renewal attempts run on the warning 24 hours before expiry and again one hour before deletion if still unpaid. A renewal already accepted continues even if auto-renewal is disabled afterwards."
      },
      "delete": {
        "tags": [
          "Backups"
        ],
        "summary": "Delete backup service",
        "operationId": "delete-backup-service",
        "parameters": [
          {
            "name": "service_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Service Id"
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "0.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "backup_service_id": 51,
                    "backup_id": null,
                    "worker_operation_id": null,
                    "guest_initialization": null,
                    "application": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Deletes the service and all its backups. Deletion is asynchronous and irreversible. Does not refund unused paid storage. For a manual copy use this endpoint rather than deleting the copy alone.\n\nSend Idempotency-Key. HTTP 202 returns order_id; poll GET /orders/{order_id}. Acceptance is not completion. worker_operation_id appears after dispatch. Free actions are also recorded as zero-amount orders."
      }
    },
    "/backup-services/{service_id}/renew": {
      "post": {
        "tags": [
          "Backups"
        ],
        "summary": "Renew backup service",
        "operationId": "renew-backup-service",
        "parameters": [
          {
            "name": "service_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Service Id"
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BackupPaymentBody"
              },
              "example": {
                "api_key_id": 1
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "1.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "backup_service_id": 51,
                    "backup_id": null,
                    "worker_operation_id": null,
                    "guest_initialization": null,
                    "application": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Extends paid_until by one calendar month from max(current paid_until, now), using current backup prices without markup or discounts. Manual storage uses the measured copy size. Automatic storage uses the current VPS plan; after VPS deletion, the last saved service plan is used. The charge and order are recorded together. A rejected renewal is refunded. Available until deletion starts, within the 24-hour expiry grace period.\n\nSend Idempotency-Key. HTTP 202 returns order_id; poll GET /orders/{order_id}. Acceptance is not completion. worker_operation_id appears after dispatch. Free actions are also recorded as zero-amount orders."
      }
    },
    "/backup-services/{service_id}/backups": {
      "get": {
        "tags": [
          "Backups"
        ],
        "summary": "List backups",
        "operationId": "list-backups",
        "parameters": [
          {
            "name": "service_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Service Id"
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "default": 25,
              "title": "Limit"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0,
              "title": "Offset"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupsResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Lists non-deleted copies of a paid service, newest first. Copies are available only after initial purchase payment is confirmed. total_count is the number of matching copies. Backup storage size (stored_size_bytes) and ZIP download size (export size_bytes) are different measurements. The export is built separately from the reconstructed disk image and compressed again, so its size may be larger or smaller. A size difference alone does not indicate a damaged backup."
      }
    },
    "/backups/{backup_id}": {
      "get": {
        "tags": [
          "Backups"
        ],
        "summary": "Backup details",
        "operationId": "get-backup",
        "parameters": [
          {
            "name": "backup_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Backup Id"
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns copy status, measured sizes and public VM configuration. No encryption keys, infrastructure credentials or saved access passwords are returned. Backup storage size (stored_size_bytes) and ZIP download size (export size_bytes) are different measurements. The export is built separately from the reconstructed disk image and compressed again, so its size may be larger or smaller. A size difference alone does not indicate a damaged backup."
      },
      "delete": {
        "tags": [
          "Backups"
        ],
        "summary": "Delete backup",
        "operationId": "delete-backup",
        "parameters": [
          {
            "name": "backup_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Backup Id"
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "0.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "backup_service_id": 51,
                    "backup_id": null,
                    "worker_operation_id": null,
                    "guest_initialization": null,
                    "application": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Deletes one automatic backup. The automatic service remains enabled. For a manual copy delete its service. Busy copies may be unavailable for deletion.\n\nSend Idempotency-Key. HTTP 202 returns order_id; poll GET /orders/{order_id}. Acceptance is not completion. worker_operation_id appears after dispatch. Free actions are also recorded as zero-amount orders."
      }
    },
    "/backups/{backup_id}/restore": {
      "post": {
        "tags": [
          "Backups"
        ],
        "summary": "Restore original VPS",
        "operationId": "restore-backup",
        "parameters": [
          {
            "name": "backup_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Backup Id"
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BackupRestoreInput"
              },
              "example": {
                "api_key_id": 1,
                "vm_id": 101
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "0.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "backup_service_id": 51,
                    "backup_id": null,
                    "worker_operation_id": null,
                    "guest_initialization": null,
                    "application": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "429": {
            "description": "Rolling 24-hour operation limit reached",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "backup_limit_reached",
                    "message": "Достигнут лимит операций бекапов за 24 часа"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Restores disks of the original VPS; vm_id must identify that VPS. Existing disk contents are overwritten. Access credentials and programs come from the backup. No separate restore fee. Maximum 3 accepted restores per service in a rolling 24-hour window, shared with creation of a new VPS from its backups. Accepted pending and failed attempts count; repeating the same Idempotency-Key does not. HTTP 429 backup_limit_reached means the limit is reached.\n\nSend Idempotency-Key. HTTP 202 returns order_id; poll GET /orders/{order_id}. Acceptance is not completion. worker_operation_id appears after dispatch. Free actions are also recorded as zero-amount orders.\n\nAdministrative blocks: admin_blocked_at and admin_block_reason are separate from status. Renewal does not unblock or start the server. Restrictions and errors: [administrative blocks](./quick-start#administrative-blocks)."
      }
    },
    "/backups/{backup_id}/exports": {
      "post": {
        "tags": [
          "Backups"
        ],
        "summary": "Prepare backup download",
        "operationId": "export-backup",
        "parameters": [
          {
            "name": "backup_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Backup Id"
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiRequest"
              },
              "example": {
                "api_key_id": 1
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "0.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "backup_service_id": 51,
                    "backup_id": null,
                    "worker_operation_id": null,
                    "guest_initialization": null,
                    "application": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "429": {
            "description": "Rolling 24-hour operation limit reached",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "backup_limit_reached",
                    "message": "Достигнут лимит операций бекапов за 24 часа"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Prepares a ZIP64 archive with raw disks and configuration. No separate export fee. Maximum one accepted export per copy in a rolling 24-hour window, including pending/failed attempts. Same-key retries do not consume another slot. Use the order worker_operation_id to read export status and obtain a link. The prepared archive is retained for 24 hours after completion.\n\nSend Idempotency-Key. HTTP 202 returns order_id; poll GET /orders/{order_id}. Acceptance is not completion. worker_operation_id appears after dispatch. Free actions are also recorded as zero-amount orders. Backup storage size (stored_size_bytes) and ZIP download size (export size_bytes) are different measurements. The export is built separately from the reconstructed disk image and compressed again, so its size may be larger or smaller. A size difference alone does not indicate a damaged backup."
      }
    },
    "/backup-exports/{operation_id}": {
      "get": {
        "tags": [
          "Backups"
        ],
        "summary": "Backup export status",
        "operationId": "get-backup-export",
        "parameters": [
          {
            "name": "operation_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Operation Id"
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupExportResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Read status by worker_operation_id from the export order. ready means a file is available; expired means its retention period has ended. No signed URL is returned here. Backup storage size (stored_size_bytes) and ZIP download size (export size_bytes) are different measurements. The export is built separately from the reconstructed disk image and compressed again, so its size may be larger or smaller. A size difference alone does not indicate a damaged backup."
      }
    },
    "/backup-exports/{operation_id}/download": {
      "get": {
        "tags": [
          "Backups"
        ],
        "summary": "Backup download link",
        "operationId": "download-backup-export",
        "parameters": [
          {
            "name": "operation_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Operation Id"
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupExportResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Returns a temporary download URL for a ready archive. The URL is valid for at most one hour and never beyond archive expiry. Reissuing a link does not consume the export preparation limit or extend the 24-hour archive retention. The limit does not restrict the number of downloads of the prepared file. Treat the URL as a secret. Cache-Control: no-store. Backup storage size (stored_size_bytes) and ZIP download size (export size_bytes) are different measurements. The export is built separately from the reconstructed disk image and compressed again, so its size may be larger or smaller. A size difference alone does not indicate a damaged backup."
      }
    },
    "/backup-operations/{operation_id}": {
      "get": {
        "tags": [
          "Backups"
        ],
        "summary": "Backup operation status",
        "operationId": "get-backup-operation",
        "parameters": [
          {
            "name": "operation_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Operation Id"
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupOperationResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Read operation_id = worker_operation_id from an order. This endpoint also accepts IDs from backup webhooks. It reports worker execution; the order separately confirms payment. Internal requests and raw infrastructure errors are not returned."
      }
    },
    "/backup-services/quote": {
      "post": {
        "tags": [
          "Backups"
        ],
        "summary": "Calculate backup service price",
        "operationId": "quote-backup-service",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BackupCreateBody"
              },
              "example": {
                "api_key_id": 1,
                "vm_id": 101,
                "kind": "automatic",
                "auto_renew": false
              }
            }
          }
        },
        "responses": {
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "200": {
            "description": "Price quote",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupQuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "1.0000",
                    "balance_usd": "100.0000",
                    "currency": "USD",
                    "months": 1,
                    "kind": "automatic",
                    "manual_gb_month_price_usd": null,
                    "exact_size_available_after_backup": false
                  }
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Calculates without creating an order or charging the balance. No Idempotency-Key required. Automatic storage uses the current plan price; manual renewal uses measured size. For a new manual backup amount_usd=0.0000 and exact_size_available_after_backup=true: this is not the final cost; manual_gb_month_price_usd is the monthly rate per GiB. Send expected_amount_usd and expected_manual_rate_usd when purchasing to receive 409 price_changed if the price changes."
      }
    },
    "/backup-services/{service_id}/renew/quote": {
      "post": {
        "tags": [
          "Backups"
        ],
        "summary": "Calculate backup renewal price",
        "operationId": "quote-backup-renewal",
        "parameters": [
          {
            "name": "service_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Service Id"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BackupPaymentBody"
              },
              "example": {
                "api_key_id": 1
              }
            }
          }
        },
        "responses": {
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "200": {
            "description": "Price quote",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupQuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "1.0000",
                    "balance_usd": "100.0000",
                    "currency": "USD",
                    "months": 1,
                    "kind": "automatic",
                    "manual_gb_month_price_usd": null,
                    "exact_size_available_after_backup": false
                  }
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Calculates without creating an order or charging the balance. No Idempotency-Key required. Automatic storage uses the current plan price; manual renewal uses measured size. For a new manual backup amount_usd=0.0000 and exact_size_available_after_backup=true: this is not the final cost; manual_gb_month_price_usd is the monthly rate per GiB. Send expected_amount_usd and expected_manual_rate_usd when purchasing to receive 409 price_changed if the price changes."
      }
    },
    "/ips/quote": {
      "post": {
        "tags": [
          "IP addresses"
        ],
        "summary": "Quote IPv4 without a VPS",
        "operationId": "quote-standalone-ip",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IpPurchaseRequest"
              },
              "example": {
                "api_key_id": 1,
                "api_user_id": "customer-123",
                "location_id": 4,
                "months": 3,
                "auto_renew": false
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IpPurchaseQuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "4.5000",
                    "balance_usd": "100.0000",
                    "currency": "USD",
                    "location_id": 4,
                    "months": 3,
                    "monthly_price_usd": "1.5000"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "One IPv4 in the selected location, without a VPS or cluster selection. Terms: 1/3/6/12/24/36 calendar months (default 1). Price is the fixed monthly rate from GET /plans times months, without markup or discount. The address belongs to api_user_id. auto_renew defaults to false; when enabled, renewals use the last paid term and current price.\n\nThe quote does not allocate an address or debit the balance; insufficient balance is allowed. Send amount_usd as expected_amount_usd when purchasing."
      }
    },
    "/alerts": {
      "get": {
        "tags": [
          "Alerts"
        ],
        "summary": "Alerts",
        "operationId": "list-alerts",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AlertsResponse"
                },
                "example": {
                  "success": true,
                  "alerts": [
                    {
                      "id": 1,
                      "text_ru": "🇵🇱 Польша: добавлены мощности VPS на AMD Ryzen 9 9950X3D.",
                      "text_en": "🇵🇱 Poland: VPS capacity added on AMD Ryzen 9 9950X3D.",
                      "created_at": "2026-10-18T10:00:00Z",
                      "starts_at": null,
                      "ends_at": null,
                      "locations": [
                        {
                          "location_id": 1,
                          "location_name": "Poland",
                          "country_code": "PL"
                        }
                      ]
                    },
                    {
                      "id": 2,
                      "text_ru": "Плановое обновление нод с перезагрузкой серверов.",
                      "text_en": "Scheduled node maintenance with server restarts.",
                      "created_at": "2026-10-18T09:00:00Z",
                      "starts_at": "2026-10-19T02:00:00Z",
                      "ends_at": "2026-10-19T03:00:00Z",
                      "locations": [
                        {
                          "location_id": 1,
                          "location_name": "Poland",
                          "country_code": "PL"
                        },
                        {
                          "location_id": 2,
                          "location_name": "Germany",
                          "country_code": "DE"
                        }
                      ]
                    }
                  ]
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Alerts temporarily unavailable",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Cloud announcements and scheduled maintenance. Only enabled alerts are returned, newest first by created_at and id. Both texts are included in the same response. created_at is the creation date; starts_at and ends_at are optional event dates in UTC (ISO 8601). Future events are visible immediately. Past events remain listed while the alert is enabled. When no alerts exist, alerts is an empty array.\n\nLocations associated with the alert, ordered by location_id. An empty array means no location link. The list is saved with the alert: locations added later are not included automatically. Display names and country codes are stored for this alert and remain unchanged when locations are renamed."
      }
    },
    "/mail/mailboxes": {
      "get": {
        "tags": [
          "Mail"
        ],
        "summary": "Mailboxes",
        "operationId": "list-mailboxes",
        "description": "Lists integration mailboxes excluding deleted ones, newest first. api_user_id is an optional exact customer filter. total_count is the number matching the filter before pagination. Sending limits and usage are included in the same response.\n\nSending limits are independent of storage: 1000 recipients in the last 24 hours, or 5000 with outbound_high_limit=true; 30 messages in the last 60 seconds; 50 recipients per message across To/Cc/Bcc. SMTP and API share the counters. Usage counts accepted sending attempts, not confirmed delivery. remaining=max(0, limit-used). If usage cannot be read, the request returns 503 rather than zero usage.",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          },
          {
            "name": "api_user_id",
            "in": "query",
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255
            },
            "description": "Your stable customer identifier within this integration."
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 25
            }
          },
          {
            "name": "offset",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailMailboxesResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": 5,
                      "account_id": 12,
                      "domain_id": 8,
                      "email": "team@example.com",
                      "name": "Team",
                      "status": "active",
                      "enabled": true,
                      "access_allowed": true,
                      "quota_mb": 10240,
                      "used_bytes": 1048576,
                      "file_quota_bytes": 10737418240,
                      "file_used_bytes": 0,
                      "signature": "",
                      "ready_at": "2026-10-18T12:00:00Z",
                      "paid_until": "2026-11-18T12:00:00Z",
                      "delete_after": "2026-11-19T12:00:00Z",
                      "created_at": "2026-10-18T11:59:30Z",
                      "updated_at": "2026-10-18T12:00:00Z",
                      "api_user_id": "customer-42",
                      "auto_renew": false,
                      "outbound_high_limit": false,
                      "outbound_daily_recipient_limit": 1000,
                      "outbound_daily_recipients_used": 120,
                      "outbound_daily_recipients_remaining": 880,
                      "outbound_messages_per_minute": 30,
                      "outbound_minute_messages_used": 2,
                      "outbound_minute_messages_remaining": 28,
                      "outbound_recipients_per_message": 50,
                      "storage_shared": true
                    }
                  ],
                  "total_count": 1
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Buy a mailbox",
        "operationId": "purchase-mailbox",
        "description": "Buys a mailbox for one calendar month, charged to the integration balance at the catalog price. account_id determines api_user_id; domain_id must be active and available to that account. The address is local_part@domain. Use the plan price directly: no purchase quote is required. The paid period begins when provisioning completes. HTTP 202 means the order was accepted; read GET /orders/{order_id} until completed and use mailbox_id to retrieve the mailbox. auto_renew defaults to false.",
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 8,
              "maxLength": 128,
              "pattern": "^[!-~]+$"
            },
            "example": "mail-order-20261019-001",
            "description": "Unique command key. Repeat the same command with the same key after a timeout. Reusing an order key with different parameters returns 409."
          }
        ],
        "responses": {
          "202": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "1.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "mailbox_id": null,
                    "mail_operation_id": null,
                    "paid_until": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailPurchase"
              },
              "example": {
                "api_key_id": 1,
                "account_id": 12,
                "domain_id": 8,
                "local_part": "team",
                "name": "Team",
                "password": "ExamplePassword42!",
                "plan_code": "mail-10",
                "auto_renew": false,
                "expected_amount_usd": "1.0000"
              }
            }
          }
        }
      }
    },
    "/mail/mailboxes/{mailbox_id}": {
      "get": {
        "tags": [
          "Mail"
        ],
        "summary": "Mailbox details",
        "operationId": "get-mailbox",
        "description": "Returns the mailbox, storage usage, access state, paid term, auto-renewal setting, sending limits and usage. All dates are UTC. A null paid_until means the paid period is not yet confirmed.\n\nSending limits are independent of storage: 1000 recipients in the last 24 hours, or 5000 with outbound_high_limit=true; 30 messages in the last 60 seconds; 50 recipients per message across To/Cc/Bcc. SMTP and API share the counters. Usage counts accepted sending attempts, not confirmed delivery. remaining=max(0, limit-used). If usage cannot be read, the request returns 503 rather than zero usage.",
        "parameters": [
          {
            "name": "mailbox_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailMailboxResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 5,
                    "account_id": 12,
                    "domain_id": 8,
                    "email": "team@example.com",
                    "name": "Team",
                    "status": "active",
                    "enabled": true,
                    "access_allowed": true,
                    "quota_mb": 10240,
                    "used_bytes": 1048576,
                    "file_quota_bytes": 10737418240,
                    "file_used_bytes": 0,
                    "signature": "",
                    "ready_at": "2026-10-18T12:00:00Z",
                    "paid_until": "2026-11-18T12:00:00Z",
                    "delete_after": "2026-11-19T12:00:00Z",
                    "created_at": "2026-10-18T11:59:30Z",
                    "updated_at": "2026-10-18T12:00:00Z",
                    "api_user_id": "customer-42",
                    "auto_renew": false,
                    "outbound_high_limit": false,
                    "outbound_daily_recipient_limit": 1000,
                    "outbound_daily_recipients_used": 120,
                    "outbound_daily_recipients_remaining": 880,
                    "outbound_messages_per_minute": 30,
                    "outbound_minute_messages_used": 2,
                    "outbound_minute_messages_remaining": 28,
                    "outbound_recipients_per_message": 50,
                    "storage_shared": true
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Mail"
        ],
        "summary": "Delete a mailbox",
        "operationId": "delete-mailbox",
        "description": "Creates a free asynchronous deletion order. Deletion removes the mailbox, messages and files. The unused paid term is not refunded. HTTP 202 is acceptance, not confirmation of deletion; read the order and mailbox.deleted webhook.",
        "parameters": [
          {
            "name": "mailbox_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 8,
              "maxLength": 128,
              "pattern": "^[!-~]+$"
            },
            "example": "mail-order-20261019-001",
            "description": "Unique command key. Repeat the same command with the same key after a timeout. Reusing an order key with different parameters returns 409."
          }
        ],
        "responses": {
          "202": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "0.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "mailbox_id": 5,
                    "mail_operation_id": null,
                    "paid_until": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Mail"
        ],
        "summary": "Update mailbox settings",
        "operationId": "update-mailbox",
        "description": "Changes name, mailbox password or signature asynchronously. Omitted and null fields remain unchanged; send an empty signature to clear it. HTTP 200 returns an operation, not a completed change. Poll its UUID through the account operations endpoint. This does not change account login/password, storage size or paid term.",
        "parameters": [
          {
            "name": "mailbox_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 8,
              "maxLength": 128,
              "pattern": "^[!-~]+$"
            },
            "example": "mail-order-20261019-001",
            "description": "Unique command key. Repeat the same command with the same key after a timeout. Reusing an order key with different parameters returns 409."
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": "645b8d90-b2a5-4d6d-b9f5-99798d86bef2",
                    "kind": "mailbox_update",
                    "mailbox_id": 5,
                    "status": "queued",
                    "run_at": "2026-10-19T12:00:00Z",
                    "created_at": "2026-10-19T12:00:00Z",
                    "completed_at": null,
                    "error": null,
                    "result": {}
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailboxSettings"
              },
              "example": {
                "api_key_id": 1,
                "name": "Support",
                "signature": ""
              }
            }
          }
        }
      }
    },
    "/mail/accounts/{account_id}/operations/{operation_id}": {
      "get": {
        "tags": [
          "Mail"
        ],
        "summary": "Mail operation",
        "operationId": "get-mail-operation",
        "description": "Returns an operation belonging to the account. The UUID is returned by a settings request or as mail_operation_id in a paid order. queued/running means work is pending; succeeded means success; failed means failure; uncertain means the outcome is unconfirmed; cancelled means cancellation. result contains only public result fields. error contains a public code or null. A sending operation is not a billing order, and acceptance does not confirm delivery.",
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "operation_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": "645b8d90-b2a5-4d6d-b9f5-99798d86bef2",
                    "kind": "mailbox_update",
                    "mailbox_id": 5,
                    "status": "queued",
                    "run_at": "2026-10-19T12:00:00Z",
                    "created_at": "2026-10-19T12:00:00Z",
                    "completed_at": null,
                    "error": null,
                    "result": {}
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/mail/plans": {
      "get": {
        "tags": [
          "Mail"
        ],
        "summary": "Mail plans",
        "operationId": "get-mail-plans",
        "description": "Available storage plans and final monthly prices in USD. No integration markup is added. Use an active code as plan_code when buying or upgrading a mailbox. The period is one calendar month; only storage upgrades are supported. Messages, attachments and files share one storage quota. mail_quota_mb and file_quota_mb represent one limit, not two separate allocations.",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailPlansResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "currency": "USD",
                    "period": "calendar_month",
                    "upgrade_only": true,
                    "max_mail_quota_mb": 102400,
                    "storage_step_mb": 10240,
                    "plans": [
                      {
                        "code": "mail-10",
                        "mail_quota_mb": 10240,
                        "file_quota_mb": 10240,
                        "monthly_price_usd": "1.00",
                        "active": true,
                        "storage_shared": true
                      }
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/mail/accounts": {
      "get": {
        "tags": [
          "Mail"
        ],
        "summary": "Mail accounts",
        "operationId": "list-mail-accounts",
        "description": "All customer accounts of this integration. No customer filter is required. Returns an empty array before the first account is created. Passwords are not returned.",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailAccountsResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": 12,
                      "api_user_id": "customer-42",
                      "login": "user-12",
                      "name": "Customer 42",
                      "enabled": true,
                      "created_at": "2026-10-19T12:00:00Z",
                      "updated_at": "2026-10-19T12:00:00Z"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Create a mail account",
        "operationId": "create-mail-account",
        "description": "Creates a free customer account linked to your api_user_id. Repeating the same api_user_id and name returns the existing account without its password; different data returns 409. The generated login and password can be used at adapt-mail.com. Save the password from this response; to replace it, use password-reset. This does not create a mailbox.",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailAccountSecretResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 12,
                    "api_user_id": "customer-42",
                    "login": "user-12",
                    "name": "Customer 42",
                    "enabled": true,
                    "created_at": "2026-10-19T12:00:00Z",
                    "updated_at": "2026-10-19T12:00:00Z",
                    "password": "ExampleGeneratedPassword42!"
                  }
                }
              }
            },
            "headers": {
              "Cache-Control": {
                "schema": {
                  "type": "string",
                  "enum": [
                    "no-store"
                  ]
                },
                "description": "Do not cache this response."
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailAccountCreate"
              },
              "example": {
                "api_key_id": 1,
                "api_user_id": "customer-42",
                "name": "Customer 42"
              }
            }
          }
        }
      }
    },
    "/mail/accounts/{account_id}": {
      "get": {
        "tags": [
          "Mail"
        ],
        "summary": "Mail account details",
        "operationId": "get-mail-account",
        "description": "Returns an account owned by this integration, including its login and api_user_id. The password is not returned.",
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailAccountResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 12,
                    "api_user_id": "customer-42",
                    "login": "user-12",
                    "name": "Customer 42",
                    "enabled": true,
                    "created_at": "2026-10-19T12:00:00Z",
                    "updated_at": "2026-10-19T12:00:00Z"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Mail"
        ],
        "summary": "Update a mail account",
        "operationId": "update-mail-account",
        "description": "Changes name, account access or password. Omitted and null fields remain unchanged. Disabling the account blocks access without changing paid terms. Changing the password or disabling the account revokes its sessions.",
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailAccountResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 12,
                    "api_user_id": "customer-42",
                    "login": "user-12",
                    "name": "Customer 42",
                    "enabled": true,
                    "created_at": "2026-10-19T12:00:00Z",
                    "updated_at": "2026-10-19T12:00:00Z"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailAccountUpdate"
              },
              "example": {
                "api_key_id": 1,
                "name": "Customer 42",
                "enabled": true
              }
            }
          }
        }
      }
    },
    "/mail/accounts/{account_id}/password-reset": {
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Reset account password",
        "operationId": "reset-mail-account-password",
        "description": "Generates a new account password and revokes account sessions. Returns the new password only in this response. Does not change individual mailbox passwords.",
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailAccountSecretResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 12,
                    "api_user_id": "customer-42",
                    "login": "user-12",
                    "name": "Customer 42",
                    "enabled": true,
                    "created_at": "2026-10-19T12:00:00Z",
                    "updated_at": "2026-10-19T12:00:00Z",
                    "password": "ExampleGeneratedPassword42!"
                  }
                }
              }
            },
            "headers": {
              "Cache-Control": {
                "schema": {
                  "type": "string",
                  "enum": [
                    "no-store"
                  ]
                },
                "description": "Do not cache this response."
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailRequest"
              },
              "example": {
                "api_key_id": 1
              }
            }
          }
        }
      }
    },
    "/mail/domains": {
      "get": {
        "tags": [
          "Mail"
        ],
        "summary": "Integration domains",
        "operationId": "list-mail-domains",
        "description": "All non-deleted customer domains of the integration, newest first, with account_id and api_user_id. No account selection is required. Shared domains are not included.",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailDomainsResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": 8,
                      "name": "example.com",
                      "status": "pending",
                      "is_shared": false,
                      "account_id": 12,
                      "api_user_id": "customer-42"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/mail/accounts/{account_id}/domains": {
      "get": {
        "tags": [
          "Mail"
        ],
        "summary": "Account domains",
        "operationId": "list-mail-account-domains",
        "description": "Returns the customer’s own domains and available shared domains. Use an active domain ID to create a mailbox.",
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailAccountDomainsResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": 8,
                      "name": "example.com",
                      "status": "pending",
                      "is_shared": false
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Connect a domain",
        "operationId": "create-mail-domain",
        "description": "Registers a domain in pending state. Send a full domain name such as example.com, without http://, https://, paths or ports. Publish the records from the DNS endpoint, then call verify. An already connected domain returns 409.",
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailDomainResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 8,
                    "name": "example.com",
                    "status": "pending",
                    "is_shared": false
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailDomainCreate"
              },
              "example": {
                "api_key_id": 1,
                "name": "example.com"
              }
            }
          }
        }
      }
    },
    "/mail/accounts/{account_id}/domains/{domain_id}": {
      "delete": {
        "tags": [
          "Mail"
        ],
        "summary": "Delete a domain",
        "operationId": "delete-mail-domain",
        "description": "Deletes an owned domain only after all of its mailboxes have been deleted, including creating, suspended and deleting mailboxes. Shared domains cannot be deleted. If deletion is not confirmed, repeat this request; a deleting domain cannot create mailboxes. Domain deletion does not edit records at your DNS provider.",
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "domain_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailDeletedResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "deleted": true
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/mail/accounts/{account_id}/domains/{domain_id}/dns": {
      "get": {
        "tags": [
          "Mail"
        ],
        "summary": "Domain DNS records",
        "operationId": "get-mail-domain-dns",
        "description": "Returns the required DNS records and observed values. name is the record name, value is its full expected value, matches indicates a match. For MX, split value into priority and mail server: \"10 mx1.adapt-mail.com\" means priority 10 and server mx1.adapt-mail.com. A record may contain error=dns_unavailable. GET checks records but does not activate the domain. DKIM is included after verification. See the mail setup guide.",
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "domain_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailDnsResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "domain_id": 8,
                    "status": "pending",
                    "records": [
                      {
                        "type": "TXT",
                        "name": "_adapt-mail.example.com",
                        "value": "adapt-mail-verification=EXAMPLE_TOKEN",
                        "observed": [],
                        "matches": false
                      },
                      {
                        "type": "MX",
                        "name": "example.com",
                        "value": "10 mx1.adapt-mail.com",
                        "observed": [
                          "10 mx1.adapt-mail.com."
                        ],
                        "matches": true
                      },
                      {
                        "type": "TXT",
                        "name": "example.com",
                        "value": "v=spf1 ip4:199.89.134.7 ip4:199.89.134.8 -all",
                        "observed": [
                          "v=spf1 ip4:199.89.134.7 ip4:199.89.134.8 -all"
                        ],
                        "matches": true
                      },
                      {
                        "type": "TXT",
                        "name": "_dmarc.example.com",
                        "value": "v=DMARC1; p=none",
                        "observed": [
                          "v=DMARC1; p=none"
                        ],
                        "matches": true
                      }
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/mail/accounts/{account_id}/domains/{domain_id}/verify": {
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Verify a domain",
        "operationId": "verify-mail-domain",
        "description": "Verifies the ownership TXT record and activates the domain. A missing verification TXT returns 409. The response includes DNS records, including the generated DKIM TXT. Publish DKIM as well and check DNS again. status=active confirms activation, not that every DNS record matches: inspect records[].matches.",
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "domain_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailDnsResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "domain_id": 8,
                    "status": "active",
                    "records": [
                      {
                        "type": "TXT",
                        "name": "_adapt-mail.example.com",
                        "value": "adapt-mail-verification=EXAMPLE_TOKEN",
                        "observed": [
                          "adapt-mail-verification=EXAMPLE_TOKEN"
                        ],
                        "matches": true
                      },
                      {
                        "type": "MX",
                        "name": "example.com",
                        "value": "10 mx1.adapt-mail.com",
                        "observed": [
                          "10 mx1.adapt-mail.com."
                        ],
                        "matches": true
                      },
                      {
                        "type": "TXT",
                        "name": "example.com",
                        "value": "v=spf1 ip4:199.89.134.7 ip4:199.89.134.8 -all",
                        "observed": [
                          "v=spf1 ip4:199.89.134.7 ip4:199.89.134.8 -all"
                        ],
                        "matches": true
                      },
                      {
                        "type": "TXT",
                        "name": "_dmarc.example.com",
                        "value": "v=DMARC1; p=none",
                        "observed": [
                          "v=DMARC1; p=none"
                        ],
                        "matches": true
                      },
                      {
                        "type": "TXT",
                        "name": "dkim._domainkey.example.com",
                        "value": "v=DKIM1; k=rsa; p=EXAMPLE_PUBLIC_KEY",
                        "observed": [],
                        "matches": false
                      }
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailRequest"
              },
              "example": {
                "api_key_id": 1
              }
            }
          }
        }
      }
    },
    "/mail/mailboxes/{mailbox_id}/renew/quote": {
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Quote mailbox renewal",
        "operationId": "quote-mailbox-renewal",
        "description": "Renews for one calendar month at the current price of the mailbox storage plan. The new term starts at the later of paid_until and the current time. Renewal is available until deletion starts and within 24 hours after expiry. It does not remove a manual access block. Returns the price and balance without charging or creating an order.",
        "parameters": [
          {
            "name": "mailbox_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailQuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "1.0000",
                    "balance_usd": "25.0000",
                    "currency": "USD",
                    "months": 1,
                    "plan": {
                      "code": "mail-10",
                      "mail_quota_mb": 10240,
                      "file_quota_mb": 10240,
                      "monthly_price_usd": "1.00",
                      "active": true,
                      "storage_shared": true
                    },
                    "allow_negative_balance": false
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailPayment"
              },
              "example": {
                "api_key_id": 1,
                "expected_amount_usd": "1.0000"
              }
            }
          }
        }
      }
    },
    "/mail/mailboxes/{mailbox_id}/renew": {
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Renew a mailbox",
        "operationId": "renew-mailbox",
        "description": "Renews for one calendar month at the current price of the mailbox storage plan. The new term starts at the later of paid_until and the current time. Renewal is available until deletion starts and within 24 hours after expiry. It does not remove a manual access block.",
        "parameters": [
          {
            "name": "mailbox_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 8,
              "maxLength": 128,
              "pattern": "^[!-~]+$"
            },
            "example": "mail-order-20261019-001",
            "description": "Unique command key. Repeat the same command with the same key after a timeout. Reusing an order key with different parameters returns 409."
          }
        ],
        "responses": {
          "202": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "1.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "mailbox_id": 5,
                    "mail_operation_id": null,
                    "paid_until": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailPayment"
              },
              "example": {
                "api_key_id": 1,
                "expected_amount_usd": "1.0000"
              }
            }
          }
        }
      }
    },
    "/mail/mailboxes/{mailbox_id}/upgrade/quote": {
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Quote a storage upgrade",
        "operationId": "quote-mailbox-upgrade",
        "description": "Increases storage to a larger active plan. The mailbox must be active and paid. The extra charge is the difference between current monthly prices multiplied by the remaining fraction of each paid calendar month, rounded to four decimal places. paid_until stays unchanged. Storage cannot be reduced. Returns the extra charge without payment.",
        "parameters": [
          {
            "name": "mailbox_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailQuoteResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "amount_usd": "0.5000",
                    "balance_usd": "25.0000",
                    "currency": "USD",
                    "months": 1,
                    "plan": {
                      "code": "mail-20",
                      "mail_quota_mb": 20480,
                      "file_quota_mb": 20480,
                      "monthly_price_usd": "2.00",
                      "active": true,
                      "storage_shared": true
                    },
                    "allow_negative_balance": false
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailUpgrade"
              },
              "example": {
                "api_key_id": 1,
                "plan_code": "mail-20",
                "expected_amount_usd": "0.5000"
              }
            }
          }
        }
      }
    },
    "/mail/mailboxes/{mailbox_id}/upgrade": {
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Upgrade mailbox storage",
        "operationId": "upgrade-mailbox",
        "description": "Increases storage to a larger active plan. The mailbox must be active and paid. The extra charge is the difference between current monthly prices multiplied by the remaining fraction of each paid calendar month, rounded to four decimal places. paid_until stays unchanged. Storage cannot be reduced.",
        "parameters": [
          {
            "name": "mailbox_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 8,
              "maxLength": 128,
              "pattern": "^[!-~]+$"
            },
            "example": "mail-order-20261019-001",
            "description": "Unique command key. Repeat the same command with the same key after a timeout. Reusing an order key with different parameters returns 409."
          }
        ],
        "responses": {
          "202": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "order_id": 401,
                    "status": "pending",
                    "amount_usd": "1.0000",
                    "currency": "USD",
                    "vm_id": null,
                    "rental_id": null,
                    "mailbox_id": 5,
                    "mail_operation_id": null,
                    "paid_until": null,
                    "error_code": null,
                    "error_message": null
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailUpgrade"
              },
              "example": {
                "api_key_id": 1,
                "plan_code": "mail-20",
                "expected_amount_usd": "0.5000"
              }
            }
          }
        }
      }
    },
    "/mail/mailboxes/{mailbox_id}/auto-renew": {
      "patch": {
        "tags": [
          "Mail"
        ],
        "summary": "Mailbox auto-renewal",
        "operationId": "set-mailbox-auto-renew",
        "description": "Enables or disables renewal from the integration balance. When enabled, renewal is attempted one hour before expiry and again one hour before deletion if still unpaid. Each renewal is one calendar month at current prices. Returns mailbox details with current sending usage.",
        "parameters": [
          {
            "name": "mailbox_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailMailboxResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 5,
                    "account_id": 12,
                    "domain_id": 8,
                    "email": "team@example.com",
                    "name": "Team",
                    "status": "active",
                    "enabled": true,
                    "access_allowed": true,
                    "quota_mb": 10240,
                    "used_bytes": 1048576,
                    "file_quota_bytes": 10737418240,
                    "file_used_bytes": 0,
                    "signature": "",
                    "ready_at": "2026-10-18T12:00:00Z",
                    "paid_until": "2026-11-18T12:00:00Z",
                    "delete_after": "2026-11-19T12:00:00Z",
                    "created_at": "2026-10-18T11:59:30Z",
                    "updated_at": "2026-10-18T12:00:00Z",
                    "api_user_id": "customer-42",
                    "auto_renew": true,
                    "outbound_high_limit": false,
                    "outbound_daily_recipient_limit": 1000,
                    "outbound_daily_recipients_used": 120,
                    "outbound_daily_recipients_remaining": 880,
                    "outbound_messages_per_minute": 30,
                    "outbound_minute_messages_used": 2,
                    "outbound_minute_messages_remaining": 28,
                    "outbound_recipients_per_message": 50,
                    "storage_shared": true
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailAutoRenew"
              },
              "example": {
                "api_key_id": 1,
                "auto_renew": true
              }
            }
          }
        }
      }
    },
    "/mail/mailboxes/{mailbox_id}/access": {
      "patch": {
        "tags": [
          "Mail"
        ],
        "summary": "Mailbox access",
        "operationId": "set-mailbox-access",
        "description": "Sets the manual enabled flag. Disabling does not pause billing or change the paid term. Enabling cannot restore an expired or deleting mailbox, or override a disabled account. Returns mailbox data without sending usage counters.",
        "parameters": [
          {
            "name": "mailbox_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailMailboxStateResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 5,
                    "account_id": 12,
                    "domain_id": 8,
                    "email": "team@example.com",
                    "name": "Team",
                    "status": "suspended",
                    "enabled": false,
                    "access_allowed": false,
                    "quota_mb": 10240,
                    "used_bytes": 1048576,
                    "file_quota_bytes": 10737418240,
                    "file_used_bytes": 0,
                    "signature": "",
                    "ready_at": "2026-10-18T12:00:00Z",
                    "paid_until": "2026-11-18T12:00:00Z",
                    "delete_after": "2026-11-19T12:00:00Z",
                    "created_at": "2026-10-18T11:59:30Z",
                    "updated_at": "2026-10-18T12:00:00Z",
                    "api_user_id": "customer-42",
                    "auto_renew": false,
                    "outbound_high_limit": false,
                    "outbound_daily_recipient_limit": 1000,
                    "outbound_messages_per_minute": 30,
                    "outbound_recipients_per_message": 50,
                    "storage_shared": true
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailAccess"
              },
              "example": {
                "api_key_id": 1,
                "enabled": false
              }
            }
          }
        }
      }
    },
    "/mail/mailboxes/{mailbox_id}/account": {
      "put": {
        "tags": [
          "Mail"
        ],
        "summary": "Change mailbox owner",
        "operationId": "assign-mailbox-account",
        "description": "Moves a mailbox to another account of the same integration and updates api_user_id. The address, password, contents and paid term are retained. Returns mailbox data without sending usage counters.",
        "parameters": [
          {
            "name": "mailbox_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailMailboxStateResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 5,
                    "account_id": 13,
                    "domain_id": 8,
                    "email": "team@example.com",
                    "name": "Team",
                    "status": "active",
                    "enabled": true,
                    "access_allowed": true,
                    "quota_mb": 10240,
                    "used_bytes": 1048576,
                    "file_quota_bytes": 10737418240,
                    "file_used_bytes": 0,
                    "signature": "",
                    "ready_at": "2026-10-18T12:00:00Z",
                    "paid_until": "2026-11-18T12:00:00Z",
                    "delete_after": "2026-11-19T12:00:00Z",
                    "created_at": "2026-10-18T11:59:30Z",
                    "updated_at": "2026-10-18T12:00:00Z",
                    "api_user_id": "customer-43",
                    "auto_renew": false,
                    "outbound_high_limit": false,
                    "outbound_daily_recipient_limit": 1000,
                    "outbound_messages_per_minute": 30,
                    "outbound_recipients_per_message": 50,
                    "storage_shared": true
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailAssign"
              },
              "example": {
                "api_key_id": 1,
                "account_id": 13
              }
            }
          }
        }
      }
    },
    "/mail/accounts/{account_id}/operations/{operation_id}/retry": {
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Retry a mail operation",
        "operationId": "retry-mail-operation",
        "description": "Retries an eligible failed settings operation without another payment. Sending operations cannot be retried through this route. An outdated settings operation cannot overwrite newer settings. For paid orders, only a storage upgrade in review can be resumed; other order retries are managed automatically. An ineligible operation returns 409. Read the operation and the associated order after acceptance.",
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "operation_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": "645b8d90-b2a5-4d6d-b9f5-99798d86bef2",
                    "kind": "mailbox_update",
                    "mailbox_id": 5,
                    "status": "queued",
                    "run_at": "2026-10-19T12:00:00Z",
                    "created_at": "2026-10-19T12:00:00Z",
                    "completed_at": null,
                    "error": null,
                    "result": {}
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailRequest"
              },
              "example": {
                "api_key_id": 1
              }
            }
          }
        }
      }
    },
    "/mail/api-keys": {
      "get": {
        "tags": [
          "Mail"
        ],
        "summary": "Mail API keys",
        "operationId": "list-mail-api-keys",
        "description": "Lists active and revoked mail keys of the integration. Only metadata is returned; use GET /mail/api-keys/{key_id} to view an active key.",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailKeysResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": 3,
                      "name": "Billing mail",
                      "prefix": "am_example12",
                      "created_at": "2026-10-19T12:00:00Z",
                      "active": true
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Create a mail API key",
        "operationId": "create-mail-api-key",
        "description": "Mail keys are for reading/sending messages and working with folders and attachments through the mail API, for example in your own mail UI or automation. They belong to the integration, not a single mailbox. Provisioning, billing and renewal use the Cloud integration key. Login at adapt-mail.com uses login/password.",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailKeyCreatedResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 3,
                    "name": "Billing mail",
                    "prefix": "am_example12",
                    "created_at": "2026-10-19T12:00:00Z",
                    "key": "am_example1234567890abcdefghijklmnopqrstuvwx123456789"
                  }
                }
              }
            },
            "headers": {
              "Cache-Control": {
                "schema": {
                  "type": "string",
                  "enum": [
                    "no-store"
                  ]
                },
                "description": "Do not cache this response."
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailKeyCreate"
              },
              "example": {
                "api_key_id": 1,
                "name": "Billing mail"
              }
            }
          }
        }
      }
    },
    "/mail/api-keys/{key_id}": {
      "get": {
        "tags": [
          "Mail"
        ],
        "summary": "View a mail API key",
        "operationId": "get-mail-api-key",
        "description": "Returns the full active key for viewing or copying. A missing, foreign or revoked key returns 404. If the value cannot be recovered, 409 mail_key_not_recoverable is returned; create a new key. The response uses Cache-Control: no-store.",
        "parameters": [
          {
            "name": "key_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailKeyDetailsResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 3,
                    "name": "Billing mail",
                    "prefix": "am_example12",
                    "created_at": "2026-10-19T12:00:00Z",
                    "active": true,
                    "key": "am_example1234567890abcdefghijklmnopqrstuvwx123456789"
                  }
                }
              }
            },
            "headers": {
              "Cache-Control": {
                "schema": {
                  "type": "string",
                  "enum": [
                    "no-store"
                  ]
                },
                "description": "Do not cache this response."
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Mail"
        ],
        "summary": "Revoke or delete a mail API key",
        "operationId": "delete-mail-api-key",
        "description": "With permanent=false (default), revokes the key and returns revoked=true. It can no longer authorize mail API requests. With permanent=true, permanently removes a revoked key and returns deleted=true. First revoke an active key: attempting to delete it directly returns 409 mail_key_active.",
        "parameters": [
          {
            "name": "key_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          },
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Integration ID matching X-Api-Key.",
            "example": 1
          },
          {
            "name": "permanent",
            "in": "query",
            "schema": {
              "type": "boolean",
              "default": false
            },
            "description": "Delete a revoked key instead of revoking it."
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailKeyRemovalResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "revoked": true
                  }
                }
              }
            },
            "headers": {
              "Cache-Control": {
                "schema": {
                  "type": "string",
                  "enum": [
                    "no-store"
                  ]
                },
                "description": "Do not cache this response."
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Resource state, payment, price or idempotency conflict. See the mail guide for error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/mail/accounts/{account_id}/login-link": {
      "post": {
        "tags": [
          "Mail"
        ],
        "summary": "Create a mail login link",
        "operationId": "create-mail-login-link",
        "description": "Creates a one-time Adapt Mail login link valid for 5 minutes. Omit mailbox_id or pass null to open the whole account; specify mailbox_id to open only that mailbox of the selected account. locale selects the interface language and defaults to en. Open the complete login_url including #token. Do not store or cache the link; create a new link after use or expiry. Passwords and existing browser logins are unchanged. Ownership and access are checked again at sign-in; changing the account password invalidates the link.",
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MailLoginLinkResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "login_url": "https://adapt-mail.com/auth/#token=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
                    "expires_in": 300,
                    "expires_at": "2026-10-21T12:05:00Z",
                    "account_id": 12,
                    "mailbox_id": 42
                  }
                }
              }
            },
            "headers": {
              "Cache-Control": {
                "schema": {
                  "type": "string",
                  "enum": [
                    "no-store"
                  ]
                },
                "description": "Do not cache this response."
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Access denied. Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Mail service or usage data temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MailLoginLinkRequest"
              },
              "example": {
                "api_key_id": 1,
                "mailbox_id": 42,
                "locale": "en"
              }
            }
          }
        }
      }
    },
    "/vms/{vm_id}/firewall/smtp": {
      "patch": {
        "tags": [
          "Firewall"
        ],
        "summary": "Open or close SMTP ports",
        "operationId": "set-firewall-smtp",
        "parameters": [
          {
            "name": "vm_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Vm Id"
            },
            "description": "vm_id parameter.",
            "example": 101
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[!-~]+$",
              "title": "Idempotency-Key"
            },
            "description": "Unique key for this intended action, 1–200 printable ASCII characters without spaces. Retry the same action with the same key and unchanged parameters.",
            "example": "example-action-20260928-001"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FirewallSmtpBody"
              },
              "example": {
                "api_key_id": 1,
                "revision": 0,
                "blocked": false
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted for processing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VmOperationResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "id": 1,
                    "vm_id": 101,
                    "action": "firewall_smtp",
                    "status": "queued",
                    "created_at": "2026-09-28T12:00:00Z",
                    "started_at": null,
                    "finished_at": null,
                    "error_code": null,
                    "error_message": null,
                    "result": null,
                    "requires_review": null
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found in this integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Business or state conflict; inspect detail",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service unavailable or result unconfirmed; for a mutation retain its idempotency key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "description": "Controls the system block on outbound TCP ports 25, 465, 587 and 2525 for IPv4 and IPv6 without restarting the VM. Send blocked=false to open the ports or blocked=true to close them.\n\nRead revision from GET /vms/{vm_id}/firewall first. Send Idempotency-Key; if the response is lost, retry with the same key and unchanged parameters. On firewall_conflict, reread the settings and submit a new command with the new revision and a new key.\n\nHTTP 202 returns a firewall_smtp operation. Poll GET /vms/{vm_id}/operations/{operation_id} until succeeded or failed. As with other firewall commands, result=null; read smtp_blocked, smtp_ports, revision and applied from GET /vms/{vm_id}/firewall. Queue acceptance does not confirm that the setting has been applied.\n\nRemoving the system block does not override provider restrictions or guest OS settings.\n\n[Request rules and errors](./quick-start) · [Lifecycle](./purchase-flow)"
      }
    },
    "/looking-glass/points": {
      "get": {
        "tags": [
          "Looking Glass"
        ],
        "operationId": "list-looking-glass-points",
        "summary": "Looking Glass points",
        "description": "Diagnostic points from the current registry. Optional location_id filters the list; no matches return data=[]. Disabled points remain listed with disabled flags. The three latency URLs are called directly by the browser to measure HTTPS latency, without an API key. See [Looking Glass](./looking-glass-guide).",
        "parameters": [
          {
            "name": "api_key_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "maximum": 9223372036854775807,
              "minimum": 1,
              "title": "Api Key Id"
            },
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key.",
            "example": 1
          },
          {
            "name": "location_id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9223372036854775807
            },
            "description": "Location ID."
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LookingGlassPointsResponse"
                },
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": 1,
                      "location_id": 2,
                      "location_name": "US — Ashburn",
                      "country_code": "US",
                      "city": "Ashburn",
                      "ipv4": "31.59.67.210",
                      "ipv6": "2602:f316:1:3::10",
                      "ipv4_enabled": true,
                      "ipv6_enabled": true,
                      "latency_url": "https://us-ash.lg.adaptgroup.pro/latency",
                      "latency_ipv4_url": "https://v4-us-ash.lg.adaptgroup.pro/latency",
                      "latency_ipv6_url": "https://v6-us-ash.lg.adaptgroup.pro/latency",
                      "checks": [
                        "ping",
                        "traceroute",
                        "mtr"
                      ]
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request fields or unsupported parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "502": {
            "description": "Looking Glass point unavailable or invalid result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "lg_agent_unavailable",
                    "message": "Точка Looking Glass недоступна или вернула некорректный ответ"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Looking Glass temporarily unavailable.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "lg_unavailable",
                    "message": "Looking Glass временно недоступен"
                  }
                }
              }
            }
          },
          "504": {
            "description": "Looking Glass response deadline exceeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "lg_timeout",
                    "message": "Истекло время ожидания Looking Glass"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/looking-glass/check": {
      "post": {
        "tags": [
          "Looking Glass"
        ],
        "operationId": "run-looking-glass-check",
        "summary": "Run diagnostics",
        "description": "Synchronous Ping/Traceroute/MTR from the selected point to a public target. Client IP is derived from the connection; client_ip and api_id are not accepted in JSON. Quotas are independent per integration. Users behind a partner backend share its IP limit within that integration. A check may wait up to five seconds for capacity; the response remains synchronous. No automatic retries or Idempotency-Key: after disconnect or HTTP 504 the command may have executed. A nonzero exit code or timed_out=true can be returned with HTTP 200. See [Looking Glass](./looking-glass-guide) for limits and output handling.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LookingGlassCheckRequest"
              },
              "example": {
                "api_key_id": 1,
                "point_id": 1,
                "type": "ping",
                "family": 4,
                "target": "1.1.1.1"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LookingGlassCheckResponse"
                },
                "example": {
                  "success": true,
                  "data": {
                    "point_id": 1,
                    "type": "ping",
                    "target": "1.1.1.1",
                    "family": 4,
                    "return_code": 0,
                    "timed_out": false,
                    "duration_ms": 4000,
                    "output": "PING 1.1.1.1 ..."
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid key, mismatched ID, or inactive integration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Client IP is not in the integration allowlist (`ip_not_allowed`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ip_not_allowed": {
                    "value": {
                      "detail": {
                        "code": "ip_not_allowed",
                        "message": "IP-адрес не входит в белый список интеграции"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Invalid request, forbidden target or DNS resolution failure.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "lg_invalid_target",
                    "message": "Некорректная или запрещённая цель, либо ошибка разрешения DNS"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Unknown Looking Glass point.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "lg_point_not_found",
                    "message": "Точка Looking Glass не найдена"
                  }
                }
              }
            }
          },
          "409": {
            "description": "Point or address family disabled.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "lg_point_disabled",
                    "message": "Точка или семейство адресов Looking Glass отключены"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Personal quota reached, point capacity unavailable, queue full or waiting time expired. Respect Retry-After.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "lg_rate_limited",
                    "message": "Превышен лимит проверок Looking Glass"
                  }
                }
              }
            },
            "headers": {
              "Retry-After": {
                "description": "Wait at least this many seconds before starting a new check.",
                "schema": {
                  "type": "string"
                },
                "example": "60"
              }
            }
          },
          "502": {
            "description": "Looking Glass point unavailable or invalid result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "lg_agent_unavailable",
                    "message": "Точка Looking Glass недоступна или вернула некорректный ответ"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Looking Glass temporarily unavailable. lg_client_ip_unavailable means the client IP could not be determined.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "lg_unavailable",
                    "message": "Looking Glass временно недоступен"
                  }
                }
              }
            }
          },
          "504": {
            "description": "Looking Glass response deadline exceeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "detail": {
                    "code": "lg_timeout",
                    "message": "Истекло время ожидания Looking Glass"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ApiRequest": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id"
        ],
        "title": "ApiRequest",
        "example": {
          "api_key_id": 1
        }
      },
      "AutoRenewBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "auto_renew"
        ],
        "title": "AutoRenewBody",
        "example": {
          "api_key_id": 1,
          "auto_renew": false
        }
      },
      "BalanceCheckResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "api_key_id": {
            "type": "integer",
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "balance": {
            "type": "string",
            "title": "Balance"
          },
          "currency": {
            "type": "string",
            "const": "USD",
            "title": "Currency",
            "default": "USD"
          },
          "balance_updated_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Balance Updated At"
          }
        },
        "type": "object",
        "required": [
          "success",
          "api_key_id",
          "balance"
        ],
        "title": "BalanceCheckResponse",
        "example": {
          "success": true,
          "api_key_id": 1,
          "balance": "100.0000",
          "currency": "USD",
          "balance_updated_at": null
        }
      },
      "DedicatedDisk": {
        "properties": {
          "count": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Count"
          },
          "size_gb": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Size Gb"
          },
          "type": {
            "type": "string",
            "title": "Type"
          },
          "model": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Model"
          },
          "id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Id",
            "description": "Opaque disk-group ID; null for a shared-layout plan."
          },
          "disk_layouts": {
            "anyOf": [
              {
                "items": {
                  "enum": [
                    "separate",
                    "lvm_linear",
                    "raid0",
                    "raid1",
                    "raid5",
                    "raid6",
                    "raid10"
                  ],
                  "type": "string"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Disk Layouts"
          },
          "default_disk_layout": {
            "anyOf": [
              {
                "enum": [
                  "separate",
                  "lvm_linear",
                  "raid0",
                  "raid1",
                  "raid5",
                  "raid6",
                  "raid10"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Default Disk Layout"
          }
        },
        "type": "object",
        "required": [
          "count",
          "size_gb",
          "type"
        ],
        "title": "DedicatedDisk"
      },
      "DedicatedHardware": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "code": {
            "type": "string",
            "title": "Code"
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "platform": {
            "type": "string",
            "enum": [
              "epyc",
              "ryzen",
              "xeon",
              "storage"
            ],
            "title": "Platform"
          },
          "cpu_model": {
            "type": "string",
            "title": "Cpu Model"
          },
          "cpu_count": {
            "type": "integer",
            "title": "Cpu Count"
          },
          "cpu_cores": {
            "type": "integer",
            "title": "Cpu Cores"
          },
          "cpu_threads": {
            "type": "integer",
            "title": "Cpu Threads"
          },
          "ram_gb": {
            "type": "integer",
            "title": "Ram Gb"
          },
          "ram_description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ram Description"
          },
          "disks": {
            "items": {
              "$ref": "#/components/schemas/DedicatedDisk"
            },
            "type": "array",
            "title": "Disks"
          },
          "disk_layouts": {
            "items": {
              "type": "string",
              "enum": [
                "separate",
                "lvm_linear",
                "raid0",
                "raid1"
              ]
            },
            "type": "array",
            "title": "Disk Layouts"
          },
          "default_disk_layout": {
            "anyOf": [
              {
                "enum": [
                  "separate",
                  "lvm_linear",
                  "raid0",
                  "raid1"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Default Disk Layout"
          },
          "port_mbps": {
            "type": "integer",
            "title": "Port Mbps"
          },
          "traffic_tb": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Traffic Tb",
            "description": "Additional integer traffic units; one unit is 1024⁴ bytes."
          },
          "included_ipv4": {
            "type": "integer",
            "title": "Included Ipv4"
          },
          "ipv6_prefix_length": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ipv6 Prefix Length"
          }
        },
        "type": "object",
        "required": [
          "id",
          "code",
          "name",
          "platform",
          "cpu_model",
          "cpu_count",
          "cpu_cores",
          "cpu_threads",
          "ram_gb",
          "ram_description",
          "disks",
          "disk_layouts",
          "default_disk_layout",
          "port_mbps",
          "traffic_tb",
          "included_ipv4",
          "ipv6_prefix_length"
        ],
        "title": "DedicatedHardware"
      },
      "DedicatedPlan": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "code": {
            "type": "string",
            "title": "Code"
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "platform": {
            "type": "string",
            "enum": [
              "epyc",
              "ryzen",
              "xeon",
              "storage"
            ],
            "title": "Platform"
          },
          "cpu_model": {
            "type": "string",
            "title": "Cpu Model"
          },
          "cpu_count": {
            "type": "integer",
            "title": "Cpu Count"
          },
          "cpu_cores": {
            "type": "integer",
            "title": "Cpu Cores"
          },
          "cpu_threads": {
            "type": "integer",
            "title": "Cpu Threads"
          },
          "ram_gb": {
            "type": "integer",
            "title": "Ram Gb"
          },
          "ram_description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ram Description"
          },
          "disks": {
            "items": {
              "$ref": "#/components/schemas/DedicatedPlanDisk"
            },
            "title": "Disks",
            "type": "array"
          },
          "disk_layouts": {
            "items": {
              "$ref": "#/components/schemas/DedicatedLayout"
            },
            "type": "array",
            "title": "Disk Layouts",
            "description": "Disk layout options: send code in requests and display name to the user."
          },
          "default_disk_layout": {
            "anyOf": [
              {
                "enum": [
                  "separate",
                  "lvm_linear",
                  "raid0",
                  "raid1"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Default Disk Layout"
          },
          "port_mbps": {
            "type": "integer",
            "title": "Port Mbps"
          },
          "traffic_tb": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Traffic Tb",
            "description": "Additional integer traffic units; one unit is 1024⁴ bytes."
          },
          "included_ipv4": {
            "type": "integer",
            "title": "Included Ipv4"
          },
          "ipv6_prefix_length": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ipv6 Prefix Length"
          },
          "location_id": {
            "type": "integer",
            "title": "Location Id"
          },
          "location_name": {
            "type": "string",
            "title": "Location Name"
          },
          "country_code": {
            "type": "string",
            "title": "Country Code"
          },
          "city": {
            "type": "string",
            "title": "City",
            "description": "Location city in its original spelling, without localization."
          },
          "datacenter": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Datacenter",
            "description": "Location datacenter name; null if not specified."
          },
          "monthly_price_usd": {
            "type": "string",
            "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
            "title": "Monthly Price Usd"
          },
          "extra_ipv4_monthly_price_usd": {
            "type": "string",
            "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
            "title": "Extra Ipv4 Monthly Price Usd"
          },
          "extra_traffic_tb_price_usd": {
            "type": "string",
            "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
            "title": "Extra Traffic Tb Price Usd"
          },
          "term_discounts": {
            "additionalProperties": {
              "type": "string",
              "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
            },
            "type": "object",
            "title": "Term Discounts"
          },
          "available": {
            "type": "integer",
            "minimum": 0.0,
            "title": "Available",
            "description": "Currently available quantity. A snapshot does not reserve capacity."
          }
        },
        "type": "object",
        "required": [
          "id",
          "code",
          "name",
          "platform",
          "cpu_model",
          "cpu_count",
          "cpu_cores",
          "cpu_threads",
          "ram_gb",
          "ram_description",
          "disks",
          "disk_layouts",
          "default_disk_layout",
          "port_mbps",
          "traffic_tb",
          "included_ipv4",
          "ipv6_prefix_length",
          "location_id",
          "location_name",
          "country_code",
          "city",
          "datacenter",
          "monthly_price_usd",
          "extra_ipv4_monthly_price_usd",
          "extra_traffic_tb_price_usd",
          "term_discounts",
          "available"
        ],
        "title": "DedicatedPlan"
      },
      "DedicatedPlansResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/DedicatedPlan"
            },
            "type": "array",
            "title": "Data"
          },
          "total_count": {
            "type": "integer",
            "title": "Total Count",
            "description": "Full matching count before pagination."
          },
          "currency": {
            "type": "string",
            "const": "USD",
            "title": "Currency",
            "default": "USD"
          },
          "updated_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Updated At"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data",
          "total_count",
          "updated_at"
        ],
        "title": "DedicatedPlansResponse",
        "example": {
          "success": true,
          "data": [
            {
              "id": 1,
              "code": "C1",
              "name": "Example",
              "platform": "epyc",
              "cpu_model": "example",
              "cpu_count": 1,
              "cpu_cores": 1,
              "cpu_threads": 1,
              "ram_gb": 1,
              "ram_description": null,
              "disks": [
                {
                  "count": 1,
                  "size_gb": 1,
                  "type": "example",
                  "model": null
                }
              ],
              "disk_layouts": [
                {
                  "code": "separate",
                  "name": "No Raid"
                }
              ],
              "default_disk_layout": "separate",
              "port_mbps": 1,
              "traffic_tb": null,
              "included_ipv4": 1,
              "ipv6_prefix_length": null,
              "location_id": 1,
              "location_name": "Poland",
              "country_code": "PL",
              "datacenter": null,
              "monthly_price_usd": "5.0000",
              "extra_ipv4_monthly_price_usd": "5.0000",
              "extra_traffic_tb_price_usd": "5.0000",
              "term_discounts": {},
              "available": 1,
              "city": "Gdańsk"
            }
          ],
          "total_count": 1,
          "currency": "USD",
          "updated_at": null
        }
      },
      "FirewallAddBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "revision": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 0.0,
            "title": "Revision",
            "description": "Current firewall revision from GET firewall. Reread on conflict."
          },
          "rule": {
            "$ref": "#/components/schemas/FirewallRule"
          },
          "position": {
            "anyOf": [
              {
                "type": "integer",
                "maximum": 100.0,
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Position"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "revision",
          "rule"
        ],
        "title": "FirewallAddBody",
        "example": {
          "api_key_id": 1,
          "revision": 0,
          "rule": {
            "direction": "IN",
            "action": "ACCEPT",
            "protocol": "tcp",
            "ports": [
              "443"
            ],
            "source": null,
            "destination": null,
            "enabled": true,
            "comment": "HTTPS"
          }
        }
      },
      "FirewallPoliciesBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "revision": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 0.0,
            "title": "Revision",
            "description": "Current firewall revision from GET firewall. Reread on conflict."
          },
          "input_policy": {
            "type": "string",
            "enum": [
              "ACCEPT",
              "DROP"
            ],
            "title": "Input Policy"
          },
          "output_policy": {
            "type": "string",
            "enum": [
              "ACCEPT",
              "DROP"
            ],
            "title": "Output Policy"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "revision",
          "input_policy",
          "output_policy"
        ],
        "title": "FirewallPoliciesBody",
        "example": {
          "api_key_id": 1,
          "revision": 0,
          "input_policy": "ACCEPT",
          "output_policy": "ACCEPT"
        }
      },
      "FirewallReorderBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "revision": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 0.0,
            "title": "Revision",
            "description": "Current firewall revision from GET firewall. Reread on conflict."
          },
          "rule_ids": {
            "items": {
              "type": "integer",
              "maximum": 9.223372036854776e+18,
              "minimum": 1.0
            },
            "type": "array",
            "maxItems": 100,
            "title": "Rule Ids",
            "description": "All existing rule IDs, once each, in the desired order."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "revision",
          "rule_ids"
        ],
        "title": "FirewallReorderBody",
        "example": {
          "api_key_id": 1,
          "revision": 0,
          "rule_ids": [
            1,
            2
          ]
        }
      },
      "FirewallRule": {
        "properties": {
          "direction": {
            "type": "string",
            "enum": [
              "IN",
              "OUT"
            ],
            "title": "Direction"
          },
          "action": {
            "type": "string",
            "enum": [
              "ACCEPT",
              "DROP"
            ],
            "title": "Action"
          },
          "protocol": {
            "type": "string",
            "enum": [
              "tcp",
              "udp",
              "tcp_udp",
              "icmp",
              "icmpv6",
              "any"
            ],
            "title": "Protocol"
          },
          "ports": {
            "items": {
              "type": "string",
              "pattern": "^[0-9]{1,5}(-[0-9]{1,5})?$"
            },
            "type": "array",
            "maxItems": 32,
            "title": "Ports"
          },
          "source": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 49
              },
              {
                "type": "null"
              }
            ],
            "title": "Source"
          },
          "destination": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 49
              },
              {
                "type": "null"
              }
            ],
            "title": "Destination"
          },
          "enabled": {
            "type": "boolean",
            "title": "Enabled",
            "default": true
          },
          "comment": {
            "type": "string",
            "maxLength": 255,
            "title": "Comment",
            "default": ""
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "direction",
          "action",
          "protocol"
        ],
        "title": "FirewallRule"
      },
      "FirewallRuleItem": {
        "properties": {
          "direction": {
            "type": "string",
            "enum": [
              "IN",
              "OUT"
            ],
            "title": "Direction"
          },
          "action": {
            "type": "string",
            "enum": [
              "ACCEPT",
              "DROP"
            ],
            "title": "Action"
          },
          "protocol": {
            "type": "string",
            "enum": [
              "tcp",
              "udp",
              "tcp_udp",
              "icmp",
              "icmpv6",
              "any"
            ],
            "title": "Protocol"
          },
          "ports": {
            "items": {
              "type": "string",
              "pattern": "^[0-9]{1,5}(-[0-9]{1,5})?$"
            },
            "type": "array",
            "maxItems": 32,
            "title": "Ports"
          },
          "source": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 49
              },
              {
                "type": "null"
              }
            ],
            "title": "Source"
          },
          "destination": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 49
              },
              {
                "type": "null"
              }
            ],
            "title": "Destination"
          },
          "enabled": {
            "type": "boolean",
            "title": "Enabled",
            "default": true
          },
          "comment": {
            "type": "string",
            "maxLength": 255,
            "title": "Comment",
            "default": ""
          },
          "id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Id"
          }
        },
        "type": "object",
        "required": [
          "direction",
          "action",
          "protocol",
          "id"
        ],
        "title": "FirewallRuleItem"
      },
      "FirewallUpdateBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "revision": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 0.0,
            "title": "Revision",
            "description": "Current firewall revision from GET firewall. Reread on conflict."
          },
          "rule": {
            "$ref": "#/components/schemas/FirewallRule"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "revision",
          "rule"
        ],
        "title": "FirewallUpdateBody",
        "example": {
          "api_key_id": 1,
          "revision": 0,
          "rule": {
            "direction": "IN",
            "action": "ACCEPT",
            "protocol": "tcp",
            "ports": [
              "443"
            ],
            "source": null,
            "destination": null,
            "enabled": true,
            "comment": "HTTPS"
          }
        }
      },
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "HeldIpv4": {
        "properties": {
          "ip_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Ip Id"
          },
          "address": {
            "type": "string",
            "format": "ipv4interface",
            "title": "Address"
          },
          "family": {
            "type": "integer",
            "const": 4,
            "title": "Family"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until",
            "description": "End of the paid service term, UTC."
          }
        },
        "type": "object",
        "required": [
          "ip_id",
          "address",
          "family",
          "paid_until"
        ],
        "title": "HeldIpv4"
      },
      "IpAutoRenewData": {
        "properties": {
          "ip_id": {
            "type": "integer",
            "title": "Ip Id"
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          }
        },
        "type": "object",
        "required": [
          "ip_id",
          "auto_renew"
        ],
        "title": "IpAutoRenewData"
      },
      "IpAutoRenewResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/IpAutoRenewData"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "IpAutoRenewResponse",
        "example": {
          "success": true,
          "data": {
            "ip_id": 301,
            "auto_renew": false
          }
        }
      },
      "IpListItem": {
        "properties": {
          "ip_id": {
            "type": "integer",
            "title": "Ip Id"
          },
          "address": {
            "type": "string",
            "title": "Address"
          },
          "family": {
            "type": "integer",
            "enum": [
              4,
              6
            ],
            "title": "Family"
          },
          "api_user_id": {
            "type": "string",
            "title": "Api User Id",
            "description": "Your customer identifier. Stored as a string; scoped to this integration."
          },
          "vm_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Vm Id"
          },
          "is_primary": {
            "type": "boolean",
            "title": "Is Primary"
          },
          "location_id": {
            "type": "integer",
            "title": "Location Id"
          },
          "location_name": {
            "type": "string",
            "title": "Location Name"
          },
          "country_code": {
            "type": "string",
            "title": "Country Code"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until",
            "description": "End of the paid service term, UTC."
          },
          "suspended_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Suspended At"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "expired",
              "suspended",
              "unknown"
            ],
            "title": "Status"
          },
          "auto_renew": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Auto Renew",
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          },
          "monthly_price_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Monthly Price Usd"
          },
          "currency": {
            "type": "string",
            "const": "USD",
            "title": "Currency",
            "default": "USD"
          }
        },
        "type": "object",
        "required": [
          "ip_id",
          "address",
          "family",
          "api_user_id",
          "vm_id",
          "is_primary",
          "location_id",
          "location_name",
          "country_code",
          "paid_until",
          "suspended_at",
          "status",
          "auto_renew",
          "monthly_price_usd"
        ],
        "title": "IpListItem"
      },
      "IpListResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/IpListItem"
            },
            "type": "array",
            "title": "Data"
          },
          "total_count": {
            "type": "integer",
            "title": "Total Count",
            "description": "Full matching count before pagination."
          }
        },
        "type": "object",
        "required": [
          "success",
          "data",
          "total_count"
        ],
        "title": "IpListResponse",
        "example": {
          "success": true,
          "data": [
            {
              "ip_id": 301,
              "address": "192.0.2.10",
              "family": 4,
              "api_user_id": "customer-123",
              "vm_id": null,
              "is_primary": true,
              "location_id": 1,
              "location_name": "Poland",
              "country_code": "PL",
              "paid_until": null,
              "suspended_at": null,
              "status": "active",
              "auto_renew": null,
              "monthly_price_usd": null,
              "currency": "USD"
            }
          ],
          "total_count": 1
        }
      },
      "IpReleaseResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/IpReleaseResult"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "IpReleaseResponse",
        "example": {
          "success": true,
          "data": {
            "operation_id": 501,
            "ip_id": 301,
            "address": "192.0.2.10",
            "family": 4,
            "status": "released"
          }
        }
      },
      "IpReleaseResult": {
        "properties": {
          "operation_id": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Operation Id"
          },
          "ip_id": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Ip Id"
          },
          "address": {
            "type": "string",
            "title": "Address"
          },
          "family": {
            "type": "integer",
            "const": 4,
            "title": "Family"
          },
          "status": {
            "type": "string",
            "const": "released",
            "title": "Status"
          }
        },
        "type": "object",
        "required": [
          "operation_id",
          "ip_id",
          "address",
          "family",
          "status"
        ],
        "title": "IpReleaseResult"
      },
      "IpRenewData": {
        "properties": {
          "order_id": {
            "type": "integer",
            "title": "Order Id"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "processing",
              "completed",
              "failed",
              "refunded",
              "review"
            ],
            "title": "Status"
          },
          "amount_usd": {
            "type": "string",
            "title": "Amount Usd",
            "description": "USD decimal string with four fractional digits; transaction amounts retain their sign."
          },
          "currency": {
            "type": "string",
            "const": "USD",
            "title": "Currency",
            "default": "USD"
          },
          "vm_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Vm Id"
          },
          "rental_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rental Id"
          },
          "error_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Code"
          },
          "error_message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Message"
          },
          "ip_id": {
            "type": "integer",
            "title": "Ip Id"
          },
          "paid_until": {
            "type": "string",
            "format": "date-time",
            "title": "Paid Until",
            "description": "End of the paid service term, UTC."
          }
        },
        "type": "object",
        "required": [
          "order_id",
          "status",
          "amount_usd",
          "vm_id",
          "error_code",
          "error_message",
          "ip_id",
          "paid_until"
        ],
        "title": "IpRenewData"
      },
      "IpRenewResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/IpRenewData"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "IpRenewResponse",
        "example": {
          "success": true,
          "data": {
            "order_id": 401,
            "status": "completed",
            "amount_usd": "5.0000",
            "currency": "USD",
            "vm_id": null,
            "rental_id": null,
            "error_code": null,
            "error_message": null,
            "ip_id": 301,
            "paid_until": "2026-10-28T12:00:00Z"
          }
        }
      },
      "LocationItem": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "country_code": {
            "type": "string",
            "title": "Country Code"
          },
          "city": {
            "type": "string",
            "title": "City",
            "description": "Location city in its original spelling, without localization."
          },
          "datacenter": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Datacenter",
            "description": "Location datacenter name; null if not specified."
          },
          "platforms": {
            "items": {
              "$ref": "#/components/schemas/PlatformItem"
            },
            "type": "array",
            "title": "Platforms"
          }
        },
        "type": "object",
        "required": [
          "id",
          "name",
          "country_code",
          "city",
          "datacenter",
          "platforms"
        ],
        "title": "LocationItem"
      },
      "MetricPoint": {
        "properties": {
          "time": {
            "type": "integer",
            "minimum": 0.0,
            "title": "Time"
          },
          "cpu_percent": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Cpu Percent",
            "description": "CPU share: 20, 40, 60, 80 or 100. Creation defaults to 60; resize keeps the current share if omitted."
          },
          "memory_used_bytes": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Memory Used Bytes"
          },
          "memory_total_bytes": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Memory Total Bytes"
          },
          "network_in_mbps": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Network In Mbps"
          },
          "network_out_mbps": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Network Out Mbps"
          },
          "disk_read_bytes_per_second": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Disk Read Bytes Per Second"
          },
          "disk_write_bytes_per_second": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Disk Write Bytes Per Second"
          }
        },
        "type": "object",
        "required": [
          "time"
        ],
        "title": "MetricPoint"
      },
      "OrderData": {
        "properties": {
          "order_id": {
            "type": "integer",
            "title": "Order Id"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "processing",
              "completed",
              "failed",
              "refunded",
              "review"
            ],
            "title": "Status"
          },
          "amount_usd": {
            "type": "string",
            "title": "Amount Usd",
            "description": "USD decimal string with four fractional digits; transaction amounts retain their sign."
          },
          "currency": {
            "type": "string",
            "const": "USD",
            "title": "Currency",
            "default": "USD"
          },
          "vm_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Vm Id"
          },
          "rental_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rental Id"
          },
          "error_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Code"
          },
          "error_message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Message"
          },
          "guest_initialization": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/VmGuestInitialization"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Latest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health."
          },
          "application": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ApplicationItem"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Application snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation."
          },
          "backup_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Backup Id"
          },
          "backup_service_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Backup Service Id"
          },
          "worker_operation_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Worker Operation Id"
          },
          "ip_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ip Id",
            "description": "For a completed IPv4 purchase/renewal; otherwise null."
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until",
            "description": "Confirmed end of the paid term for a completed IPv4 or mail order; otherwise null."
          },
          "mailbox_id": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 1
              },
              {
                "type": "null"
              }
            ]
          },
          "mail_operation_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "type": "object",
        "required": [
          "order_id",
          "status",
          "amount_usd",
          "vm_id",
          "error_code",
          "error_message"
        ],
        "title": "OrderData"
      },
      "OrderDetails": {
        "properties": {
          "order_id": {
            "type": "integer",
            "title": "Order Id"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "processing",
              "completed",
              "failed",
              "refunded",
              "review"
            ],
            "title": "Status"
          },
          "amount_usd": {
            "type": "string",
            "title": "Amount Usd",
            "description": "USD decimal string with four fractional digits; transaction amounts retain their sign."
          },
          "currency": {
            "type": "string",
            "const": "USD",
            "title": "Currency",
            "default": "USD"
          },
          "vm_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Vm Id"
          },
          "rental_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rental Id"
          },
          "error_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Code"
          },
          "error_message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Message"
          },
          "order_type": {
            "type": "string",
            "enum": [
              "vm_purchase",
              "vm_renewal",
              "vm_resize",
              "traffic_purchase",
              "ipv4_purchase",
              "ipv4_renewal",
              "dedicated_purchase",
              "dedicated_renewal",
              "backup_purchase",
              "backup_renewal",
              "backup_service_delete",
              "backup_delete",
              "backup_restore",
              "backup_export",
              "mail_purchase",
              "mail_renewal",
              "mail_upgrade",
              "mail_delete"
            ],
            "title": "Order Type"
          },
          "api_user_id": {
            "type": "string",
            "title": "Api User Id",
            "description": "Your customer identifier. Stored as a string; scoped to this integration."
          },
          "ip_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ip Id",
            "description": "For a completed IPv4 purchase/renewal; otherwise null."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "updated_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Updated At"
          },
          "completed_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "parameters": {
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                },
                {
                  "type": "boolean"
                },
                {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "type": "object"
                }
              ]
            },
            "title": "Parameters",
            "type": "object"
          },
          "guest_initialization": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/VmGuestInitialization"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Latest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health."
          },
          "application": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ApplicationItem"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Application snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation."
          },
          "backup_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Backup Id"
          },
          "backup_service_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Backup Service Id"
          },
          "worker_operation_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Worker Operation Id"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until",
            "description": "Confirmed end of the paid term for a completed IPv4 or mail order; otherwise null."
          },
          "mailbox_id": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 1
              },
              {
                "type": "null"
              }
            ]
          },
          "mail_operation_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "type": "object",
        "required": [
          "order_id",
          "status",
          "amount_usd",
          "vm_id",
          "error_code",
          "error_message",
          "order_type",
          "api_user_id",
          "ip_id",
          "created_at",
          "updated_at",
          "completed_at",
          "parameters"
        ],
        "title": "OrderDetails"
      },
      "OrderDetailsResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/OrderDetails"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "OrderDetailsResponse",
        "example": {
          "success": true,
          "data": {
            "order_id": 401,
            "status": "pending",
            "amount_usd": "5.0000",
            "currency": "USD",
            "vm_id": null,
            "rental_id": null,
            "error_code": null,
            "error_message": null,
            "order_type": "vm_purchase",
            "api_user_id": "customer-123",
            "ip_id": null,
            "created_at": "2026-09-28T12:00:00Z",
            "updated_at": null,
            "completed_at": null,
            "parameters": {}
          }
        }
      },
      "OrderListItem": {
        "properties": {
          "order_id": {
            "type": "integer",
            "title": "Order Id"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "processing",
              "completed",
              "failed",
              "refunded",
              "review"
            ],
            "title": "Status"
          },
          "amount_usd": {
            "type": "string",
            "title": "Amount Usd",
            "description": "USD decimal string with four fractional digits; transaction amounts retain their sign."
          },
          "currency": {
            "type": "string",
            "const": "USD",
            "title": "Currency",
            "default": "USD"
          },
          "vm_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Vm Id"
          },
          "rental_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rental Id"
          },
          "error_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Code"
          },
          "error_message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Message"
          },
          "order_type": {
            "type": "string",
            "enum": [
              "vm_purchase",
              "vm_renewal",
              "vm_resize",
              "traffic_purchase",
              "ipv4_purchase",
              "ipv4_renewal",
              "dedicated_purchase",
              "dedicated_renewal",
              "backup_purchase",
              "backup_renewal",
              "backup_service_delete",
              "backup_delete",
              "backup_restore",
              "backup_export",
              "mail_purchase",
              "mail_renewal",
              "mail_upgrade",
              "mail_delete"
            ],
            "title": "Order Type"
          },
          "api_user_id": {
            "type": "string",
            "title": "Api User Id",
            "description": "Your customer identifier. Stored as a string; scoped to this integration."
          },
          "ip_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ip Id",
            "description": "For a completed IPv4 purchase/renewal; otherwise null."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "updated_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Updated At"
          },
          "completed_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "guest_initialization": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/VmGuestInitialization"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Latest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health."
          },
          "application": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ApplicationItem"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Application snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation."
          },
          "backup_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Backup Id"
          },
          "backup_service_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Backup Service Id"
          },
          "worker_operation_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Worker Operation Id"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until",
            "description": "Confirmed end of the paid term for a completed IPv4 or mail order; otherwise null."
          },
          "mailbox_id": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 1
              },
              {
                "type": "null"
              }
            ]
          },
          "mail_operation_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "type": "object",
        "required": [
          "order_id",
          "status",
          "amount_usd",
          "vm_id",
          "error_code",
          "error_message",
          "order_type",
          "api_user_id",
          "ip_id",
          "created_at",
          "updated_at",
          "completed_at"
        ],
        "title": "OrderListItem"
      },
      "OrderListResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/OrderListItem"
            },
            "type": "array",
            "title": "Data"
          },
          "total_count": {
            "type": "integer",
            "title": "Total Count",
            "description": "Full matching count before pagination."
          }
        },
        "type": "object",
        "required": [
          "success",
          "data",
          "total_count"
        ],
        "title": "OrderListResponse",
        "example": {
          "success": true,
          "data": [
            {
              "order_id": 401,
              "status": "pending",
              "amount_usd": "5.0000",
              "currency": "USD",
              "vm_id": null,
              "rental_id": null,
              "error_code": null,
              "error_message": null,
              "order_type": "vm_purchase",
              "api_user_id": "customer-123",
              "ip_id": null,
              "created_at": "2026-09-28T12:00:00Z",
              "updated_at": null,
              "completed_at": null
            }
          ],
          "total_count": 1
        }
      },
      "OrderResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/OrderData"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "OrderResponse",
        "example": {
          "success": true,
          "data": {
            "order_id": 401,
            "status": "pending",
            "amount_usd": "5.0000",
            "currency": "USD",
            "vm_id": null,
            "rental_id": null,
            "error_code": null,
            "error_message": null
          }
        }
      },
      "OsItem": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "code": {
            "type": "string",
            "title": "Code"
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "logo_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Logo Url",
            "description": "OS image URL; null if no image is configured."
          }
        },
        "type": "object",
        "required": [
          "id",
          "code",
          "name",
          "logo_url"
        ],
        "title": "OsItem"
      },
      "OsListResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "os": {
            "items": {
              "$ref": "#/components/schemas/OsItem"
            },
            "type": "array",
            "title": "Os"
          }
        },
        "type": "object",
        "required": [
          "success",
          "os"
        ],
        "title": "OsListResponse",
        "example": {
          "success": true,
          "os": [
            {
              "id": 1,
              "code": "debian-12",
              "name": "Debian 12",
              "logo_url": "https://cdn.example.com/os/debian.svg"
            },
            {
              "id": 2,
              "code": "ubuntu-24.04",
              "name": "Ubuntu 24.04",
              "logo_url": null
            }
          ]
        }
      },
      "PasswordResetBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "login": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "maxLength": 32,
                "pattern": "^[a-z_][a-z0-9_-]*$"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Login",
            "description": "Existing OS user. Omitted or null: use the actual installation login, normally admin for Windows and root for Linux. Unknown installation login: HTTP 409 vm_login_required."
          },
          "password": {
            "type": "string",
            "maxLength": 1024,
            "minLength": 5,
            "title": "Password",
            "description": "Access password. Never send together with ssh_public_key.",
            "writeOnly": true
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "password"
        ],
        "title": "PasswordResetBody",
        "example": {
          "api_key_id": 1,
          "login": "root",
          "password": "Example-Password-2026!"
        }
      },
      "PasswordResetResult": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "title": "Vm Id"
          },
          "status": {
            "type": "string",
            "const": "running",
            "title": "Status"
          },
          "login": {
            "type": "string",
            "title": "Login"
          },
          "password_changed": {
            "type": "boolean",
            "const": true,
            "title": "Password Changed"
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "status",
          "login",
          "password_changed"
        ],
        "title": "PasswordResetResult"
      },
      "PlanItem": {
        "properties": {
          "code": {
            "type": "string",
            "title": "Code"
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "cpu_cores": {
            "type": "integer",
            "title": "Cpu Cores"
          },
          "ram_mb": {
            "type": "integer",
            "title": "Ram Mb"
          },
          "disk_gb": {
            "type": "integer",
            "title": "Disk Gb"
          },
          "traffic_tb": {
            "type": "string",
            "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
            "title": "Traffic Tb",
            "description": "Additional integer traffic units; one unit is 1024⁴ bytes."
          },
          "monthly_price_usd": {
            "type": "string",
            "title": "Monthly Price Usd"
          },
          "available": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Available",
            "description": "Currently available quantity. A snapshot does not reserve capacity."
          },
          "automatic_backup_monthly_price_usd": {
            "type": "string",
            "title": "Automatic Backup Monthly Price Usd",
            "description": "Monthly USD price for this plan’s automatic backups: backups are daily and the latest 7 backups are retained. Price covers the entire package, not each copy; no integration markup, CPU factor or term discount. String with four decimal places.",
            "example": "1.0000"
          }
        },
        "type": "object",
        "required": [
          "code",
          "name",
          "cpu_cores",
          "ram_mb",
          "disk_gb",
          "traffic_tb",
          "monthly_price_usd",
          "available",
          "automatic_backup_monthly_price_usd"
        ],
        "title": "PlanItem"
      },
      "PlansListResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "api_key_id": {
            "type": "integer",
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "cpu_percent": {
            "type": "integer",
            "enum": [
              20,
              40,
              60,
              80,
              100
            ],
            "title": "Cpu Percent",
            "description": "CPU share: 20, 40, 60, 80 or 100. Creation defaults to 60; resize keeps the current share if omitted."
          },
          "currency": {
            "type": "string",
            "const": "USD",
            "title": "Currency",
            "default": "USD"
          },
          "locations": {
            "items": {
              "$ref": "#/components/schemas/LocationItem"
            },
            "type": "array",
            "title": "Locations"
          },
          "manual_backup_gb_month_price_usd": {
            "type": "string",
            "title": "Manual Backup Gb Month Price Usd",
            "description": "Shared USD rate per GiB of stored manual backup per month (1 GiB = 1073741824 bytes). Manual backups are made on an existing VPS. This is a storage rate, not the total price per copy or per GiB of the VPS disk. No markup or term discount. String with six decimal places.",
            "example": "0.050000"
          }
        },
        "type": "object",
        "required": [
          "success",
          "api_key_id",
          "cpu_percent",
          "locations",
          "manual_backup_gb_month_price_usd"
        ],
        "title": "PlansListResponse",
        "example": {
          "success": true,
          "api_key_id": 1,
          "cpu_percent": 60,
          "currency": "USD",
          "locations": [
            {
              "id": 1,
              "name": "Example",
              "country_code": "PL",
              "datacenter": null,
              "platforms": [
                {
                  "platform": "epyc",
                  "cpu_display_name": "AMD EPYC",
                  "availability_updated_at": null,
                  "plans": [
                    {
                      "code": "A1",
                      "name": "A1",
                      "cpu_cores": 1,
                      "ram_mb": 1024,
                      "disk_gb": 20,
                      "traffic_tb": "5.0000",
                      "monthly_price_usd": "5.0000",
                      "available": null,
                      "automatic_backup_monthly_price_usd": "1.0000"
                    }
                  ],
                  "term_discounts": {
                    "1": "0",
                    "3": "3",
                    "6": "5",
                    "12": "8",
                    "24": "10",
                    "36": "12"
                  },
                  "extra_ipv4_monthly_price_usd": "2.0000",
                  "extra_traffic_tb_price_usd": "1.0000",
                  "cpu_max_frequency_ghz": null
                }
              ],
              "city": "Gdańsk"
            }
          ],
          "manual_backup_gb_month_price_usd": "0.050000"
        }
      },
      "PlatformItem": {
        "properties": {
          "platform": {
            "type": "string",
            "enum": [
              "epyc",
              "ryzen",
              "xeon"
            ],
            "title": "Platform",
            "description": "CPU family: epyc — AMD EPYC, ryzen — AMD Ryzen, xeon — Intel Xeon."
          },
          "cpu_display_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cpu Display Name",
            "description": "CPU family name: AMD EPYC, AMD Ryzen or Intel Xeon. This is not a specific model."
          },
          "term_discounts": {
            "additionalProperties": {
              "type": "string",
              "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
            },
            "type": "object",
            "title": "Term Discounts",
            "description": "Percentage discounts shared by all plans in this location/platform. Keys are term lengths in months as strings (1, 3, 6, 12, 24, 36); values are percentages serialized as strings."
          },
          "availability_updated_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Availability Updated At"
          },
          "plans": {
            "items": {
              "$ref": "#/components/schemas/PlanItem"
            },
            "type": "array",
            "title": "Plans"
          },
          "extra_ipv4_monthly_price_usd": {
            "type": "string",
            "title": "Extra Ipv4 Monthly Price Usd",
            "description": "Fixed monthly price in USD for one additional IPv4. Standalone and VPS add-on rentals both use calendar months. No integration markup, CPU factor or term discount applies.",
            "example": "2.0000"
          },
          "extra_traffic_tb_price_usd": {
            "type": "string",
            "title": "Extra Traffic Tb Price Usd",
            "description": "Fixed price in USD for 1 TB of additional traffic (1024^4 bytes) in the current traffic period. No integration markup, CPU factor or term discount applies.",
            "example": "1.0000"
          },
          "cpu_max_frequency_ghz": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cpu Max Frequency Ghz",
            "description": "Always null in the catalog. The CPU maximum frequency is available after provisioning in VPS lists/details when known."
          }
        },
        "type": "object",
        "required": [
          "platform",
          "cpu_display_name",
          "term_discounts",
          "availability_updated_at",
          "plans",
          "extra_ipv4_monthly_price_usd",
          "extra_traffic_tb_price_usd"
        ],
        "title": "PlatformItem"
      },
      "ReinstallBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "os_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Os Id",
            "description": "Operating system ID from GET /reference/os."
          },
          "wipe_extra_disks": {
            "type": "boolean",
            "title": "Wipe Extra Disks",
            "default": false
          },
          "password": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 1024,
                "minLength": 1
              },
              {
                "type": "null"
              }
            ],
            "title": "Password",
            "description": "Access password. Never send together with ssh_public_key. For Windows installation: 8–127 characters, at least three character categories (lowercase, uppercase, digits, special characters), no CR/LF/NUL or login substring.",
            "writeOnly": true
          },
          "ssh_public_key": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 8192,
                "minLength": 1
              },
              {
                "type": "null"
              }
            ],
            "title": "Ssh Public Key",
            "description": "One OpenSSH public-key line: Ed25519, RSA or ECDSA. Send the key itself, not a saved key ID. Not supported for Windows."
          },
          "cloud_init": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Cloud Init",
            "description": "Optional cloud-config JSON object, not a YAML string. Maximum 65536 bytes after server JSON serialization (non-ASCII characters are escaped). users, packages, runcmd and write_files must be arrays when present. Networking, hostname and primary access are managed by the platform. Retain the same object when retrying. Its result is reported separately in guest_initialization; cloud_init contents are not returned in orders or webhooks. Not supported for Windows."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "os_id"
        ],
        "title": "ReinstallBody",
        "example": {
          "api_key_id": 1,
          "os_id": 1,
          "wipe_extra_disks": false,
          "password": "Example-Password-2026!",
          "cloud_init": {
            "packages": [
              "curl"
            ],
            "runcmd": [
              [
                "sh",
                "-c",
                "echo ready > /root/cloud-init-ready"
              ]
            ]
          }
        }
      },
      "ReinstallResult": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "title": "Vm Id"
          },
          "os": {
            "type": "string",
            "title": "Os"
          },
          "hostname": {
            "type": "string",
            "title": "Hostname"
          },
          "wipe_extra_disks": {
            "type": "boolean",
            "title": "Wipe Extra Disks"
          },
          "status": {
            "type": "string",
            "const": "running",
            "title": "Status"
          },
          "guest_initialization": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/VmGuestInitialization"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Latest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health."
          },
          "application": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ApplicationItem"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Application snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation."
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "os",
          "hostname",
          "wipe_extra_disks",
          "status"
        ],
        "title": "ReinstallResult"
      },
      "RentalCreateRequest": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "months": {
            "type": "integer",
            "enum": [
              1,
              3,
              6,
              12,
              24,
              36
            ],
            "title": "Months",
            "default": 1,
            "description": "Calendar months: 1, 3, 6, 12, 24 or 36. JSON integer."
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{1,11}\\.\\d{4}$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expected Amount Usd",
            "description": "Optional confirmed price in USD, exactly four decimal places. A changed price returns 409 price_changed before charging. For a resize this is the maximum accepted price."
          },
          "api_user_id": {
            "type": "string",
            "maxLength": 255,
            "minLength": 1,
            "pattern": "\\S",
            "title": "Api User Id",
            "description": "Your customer identifier. Stored as a string; scoped to this integration."
          },
          "plan_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Plan Id",
            "description": "Dedicated plan ID from GET /dedicated/plans."
          },
          "os_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Os Id",
            "description": "Operating system ID from GET /reference/os."
          },
          "disk_layout": {
            "anyOf": [
              {
                "enum": [
                  "separate",
                  "lvm_linear",
                  "raid0",
                  "raid1"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Disk Layout"
          },
          "hostname": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 63,
                "minLength": 1,
                "pattern": "^[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Hostname"
          },
          "password": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 1024,
                "minLength": 1
              },
              {
                "type": "null"
              }
            ],
            "title": "Password",
            "description": "Access password. Never send together with ssh_public_key.",
            "writeOnly": true
          },
          "ssh_public_key": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 8192,
                "minLength": 1
              },
              {
                "type": "null"
              }
            ],
            "title": "Ssh Public Key",
            "description": "One OpenSSH public-key line: Ed25519, RSA or ECDSA. Send the key itself, not a saved key ID."
          },
          "extra_ipv4_count": {
            "type": "integer",
            "maximum": 65536.0,
            "minimum": 0.0,
            "title": "Extra Ipv4 Count",
            "default": 0
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "default": false,
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          },
          "disk_layouts": {
            "anyOf": [
              {
                "additionalProperties": {
                  "enum": [
                    "separate",
                    "lvm_linear",
                    "raid0",
                    "raid1",
                    "raid5",
                    "raid6",
                    "raid10"
                  ],
                  "type": "string"
                },
                "maxProperties": 32,
                "minProperties": 1,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Disk Layouts",
            "description": "Supply exactly one format: disk_layout for a shared-layout plan, or disk_layouts for a disk-group plan. disk_layouts maps the catalog disks[].id values to supported layout codes for those groups. Include every group and no extra keys. IDs are opaque: do not derive them from disk types. The client selects defaults; the API does not fill them in. Preserve the selection when retrying an order. HDD groups support RAID 5 (at least 3 disks), RAID 6 (at least 4) and RAID 10 (an even number of at least 4), when listed among the group options. These options are unavailable for other disk types and shared layouts."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "api_user_id",
          "plan_id",
          "os_id"
        ],
        "title": "RentalCreateRequest",
        "example": {
          "api_key_id": 1,
          "months": 1,
          "api_user_id": "customer-123",
          "plan_id": 1,
          "os_id": 1,
          "disk_layout": "separate",
          "extra_ipv4_count": 0,
          "auto_renew": false,
          "password": "Example-Password-2026!"
        },
        "oneOf": [
          {
            "required": [
              "disk_layout"
            ],
            "properties": {
              "disk_layout": {
                "type": "string"
              }
            }
          },
          {
            "required": [
              "disk_layouts"
            ],
            "properties": {
              "disk_layouts": {
                "type": "object"
              }
            }
          }
        ]
      },
      "RentalDetails": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "api_user_id": {
            "type": "string",
            "title": "Api User Id",
            "description": "Your customer identifier. Stored as a string; scoped to this integration."
          },
          "order_id": {
            "type": "integer",
            "title": "Order Id"
          },
          "status": {
            "type": "string",
            "enum": [
              "preparing",
              "active",
              "overdue",
              "cleaning",
              "completed",
              "cancelled"
            ],
            "title": "Status"
          },
          "plan": {
            "$ref": "#/components/schemas/DedicatedHardware"
          },
          "location_id": {
            "type": "integer",
            "title": "Location Id"
          },
          "location_name": {
            "type": "string",
            "title": "Location Name"
          },
          "country_code": {
            "type": "string",
            "title": "Country Code"
          },
          "datacenter": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Datacenter",
            "description": "Location datacenter name; null if not specified."
          },
          "os": {
            "type": "string",
            "title": "Os"
          },
          "hostname": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Hostname"
          },
          "disk_layout": {
            "anyOf": [
              {
                "enum": [
                  "separate",
                  "lvm_linear",
                  "raid0",
                  "raid1"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Disk Layout"
          },
          "term_months": {
            "type": "integer",
            "title": "Term Months"
          },
          "extra_ipv4_count": {
            "type": "integer",
            "title": "Extra Ipv4 Count"
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          },
          "issued_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Issued At"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until",
            "description": "End of the paid service term, UTC."
          },
          "overdue_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Overdue At"
          },
          "finished_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Finished At"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "host": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Host"
          },
          "login": {
            "type": "string",
            "title": "Login"
          },
          "password": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Password",
            "description": "Access password. Never send together with ssh_public_key."
          },
          "ssh_public_key": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ssh Public Key",
            "description": "One OpenSSH public-key line: Ed25519, RSA or ECDSA. Send the key itself, not a saved key ID."
          },
          "ips": {
            "items": {
              "$ref": "#/components/schemas/RentalIp"
            },
            "type": "array",
            "title": "Ips"
          },
          "disk_layouts": {
            "anyOf": [
              {
                "additionalProperties": {
                  "enum": [
                    "separate",
                    "lvm_linear",
                    "raid0",
                    "raid1",
                    "raid5",
                    "raid6",
                    "raid10"
                  ],
                  "type": "string"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Disk Layouts",
            "description": "Saved selections keyed by group IDs in plan.disks. Null for a shared layout."
          }
        },
        "type": "object",
        "required": [
          "id",
          "api_user_id",
          "order_id",
          "status",
          "plan",
          "location_id",
          "location_name",
          "country_code",
          "datacenter",
          "os",
          "hostname",
          "disk_layout",
          "term_months",
          "extra_ipv4_count",
          "auto_renew",
          "issued_at",
          "paid_until",
          "overdue_at",
          "finished_at",
          "created_at",
          "host",
          "login",
          "password",
          "ssh_public_key",
          "ips"
        ],
        "title": "RentalDetails"
      },
      "RentalIp": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "address": {
            "type": "string",
            "title": "Address"
          },
          "is_primary": {
            "type": "boolean",
            "title": "Is Primary"
          }
        },
        "type": "object",
        "required": [
          "id",
          "address",
          "is_primary"
        ],
        "title": "RentalIp"
      },
      "RentalItem": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "api_user_id": {
            "type": "string",
            "title": "Api User Id",
            "description": "Your customer identifier. Stored as a string; scoped to this integration."
          },
          "order_id": {
            "type": "integer",
            "title": "Order Id"
          },
          "status": {
            "type": "string",
            "enum": [
              "preparing",
              "active",
              "overdue",
              "cleaning",
              "completed",
              "cancelled"
            ],
            "title": "Status"
          },
          "plan": {
            "$ref": "#/components/schemas/DedicatedHardware"
          },
          "location_id": {
            "type": "integer",
            "title": "Location Id"
          },
          "location_name": {
            "type": "string",
            "title": "Location Name"
          },
          "country_code": {
            "type": "string",
            "title": "Country Code"
          },
          "datacenter": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Datacenter",
            "description": "Location datacenter name; null if not specified."
          },
          "os": {
            "type": "string",
            "title": "Os"
          },
          "hostname": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Hostname"
          },
          "disk_layout": {
            "anyOf": [
              {
                "enum": [
                  "separate",
                  "lvm_linear",
                  "raid0",
                  "raid1"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Disk Layout"
          },
          "term_months": {
            "type": "integer",
            "title": "Term Months"
          },
          "extra_ipv4_count": {
            "type": "integer",
            "title": "Extra Ipv4 Count"
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          },
          "issued_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Issued At"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until",
            "description": "End of the paid service term, UTC."
          },
          "overdue_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Overdue At"
          },
          "finished_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Finished At"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "disk_layouts": {
            "anyOf": [
              {
                "additionalProperties": {
                  "enum": [
                    "separate",
                    "lvm_linear",
                    "raid0",
                    "raid1",
                    "raid5",
                    "raid6",
                    "raid10"
                  ],
                  "type": "string"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Disk Layouts",
            "description": "Saved selections keyed by group IDs in plan.disks. Null for a shared layout."
          }
        },
        "type": "object",
        "required": [
          "id",
          "api_user_id",
          "order_id",
          "status",
          "plan",
          "location_id",
          "location_name",
          "country_code",
          "datacenter",
          "os",
          "hostname",
          "disk_layout",
          "term_months",
          "extra_ipv4_count",
          "auto_renew",
          "issued_at",
          "paid_until",
          "overdue_at",
          "finished_at",
          "created_at"
        ],
        "title": "RentalItem"
      },
      "RentalListResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/RentalItem"
            },
            "type": "array",
            "title": "Data"
          },
          "total_count": {
            "type": "integer",
            "title": "Total Count",
            "description": "Full matching count before pagination."
          }
        },
        "type": "object",
        "required": [
          "success",
          "data",
          "total_count"
        ],
        "title": "RentalListResponse",
        "example": {
          "success": true,
          "data": [
            {
              "id": 1,
              "api_user_id": "customer-123",
              "order_id": 401,
              "status": "preparing",
              "plan": {
                "id": 1,
                "code": "C1",
                "name": "Example",
                "platform": "epyc",
                "cpu_model": "example",
                "cpu_count": 1,
                "cpu_cores": 1,
                "cpu_threads": 1,
                "ram_gb": 1,
                "ram_description": null,
                "disks": [
                  {
                    "count": 1,
                    "size_gb": 1,
                    "type": "example",
                    "model": null
                  }
                ],
                "disk_layouts": [
                  "separate"
                ],
                "default_disk_layout": "separate",
                "port_mbps": 1,
                "traffic_tb": null,
                "included_ipv4": 1,
                "ipv6_prefix_length": null
              },
              "location_id": 1,
              "location_name": "Poland",
              "country_code": "PL",
              "datacenter": null,
              "os": "debian-12",
              "hostname": null,
              "disk_layout": "separate",
              "term_months": 1,
              "extra_ipv4_count": 1,
              "auto_renew": false,
              "issued_at": null,
              "paid_until": null,
              "overdue_at": null,
              "finished_at": null,
              "created_at": "2026-09-28T12:00:00Z"
            }
          ],
          "total_count": 1
        }
      },
      "RentalResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/RentalDetails"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "RentalResponse",
        "example": {
          "success": true,
          "data": {
            "id": 1,
            "api_user_id": "customer-123",
            "order_id": 401,
            "status": "preparing",
            "plan": {
              "id": 1,
              "code": "C1",
              "name": "Example",
              "platform": "epyc",
              "cpu_model": "example",
              "cpu_count": 1,
              "cpu_cores": 1,
              "cpu_threads": 1,
              "ram_gb": 1,
              "ram_description": null,
              "disks": [
                {
                  "count": 1,
                  "size_gb": 1,
                  "type": "example",
                  "model": null
                }
              ],
              "disk_layouts": [
                "separate"
              ],
              "default_disk_layout": "separate",
              "port_mbps": 1,
              "traffic_tb": null,
              "included_ipv4": 1,
              "ipv6_prefix_length": null
            },
            "location_id": 1,
            "location_name": "Poland",
            "country_code": "PL",
            "datacenter": null,
            "os": "debian-12",
            "hostname": null,
            "disk_layout": "separate",
            "term_months": 1,
            "extra_ipv4_count": 1,
            "auto_renew": false,
            "issued_at": null,
            "paid_until": null,
            "overdue_at": null,
            "finished_at": null,
            "created_at": "2026-09-28T12:00:00Z",
            "host": null,
            "login": "root",
            "password": null,
            "ssh_public_key": null,
            "ips": [
              {
                "id": 1,
                "address": "192.0.2.10",
                "is_primary": true
              }
            ]
          }
        }
      },
      "TrafficPeriod": {
        "properties": {
          "starts_at": {
            "type": "string",
            "format": "date-time",
            "title": "Starts At"
          },
          "ends_at": {
            "type": "string",
            "format": "date-time",
            "title": "Ends At"
          },
          "included_bytes": {
            "type": "integer",
            "title": "Included Bytes"
          },
          "additional_bytes": {
            "type": "integer",
            "title": "Additional Bytes"
          },
          "incoming_bytes": {
            "type": "integer",
            "title": "Incoming Bytes"
          },
          "outgoing_bytes": {
            "type": "integer",
            "title": "Outgoing Bytes"
          },
          "overage_bytes": {
            "type": "integer",
            "title": "Overage Bytes"
          },
          "remaining_bytes": {
            "type": "integer",
            "title": "Remaining Bytes"
          }
        },
        "type": "object",
        "required": [
          "starts_at",
          "ends_at",
          "included_bytes",
          "additional_bytes",
          "incoming_bytes",
          "outgoing_bytes",
          "overage_bytes",
          "remaining_bytes"
        ],
        "title": "TrafficPeriod"
      },
      "TrafficShaping": {
        "properties": {
          "limit_mbps": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Limit Mbps"
          },
          "reason": {
            "anyOf": [
              {
                "enum": [
                  "traffic",
                  "bandwidth",
                  "manual"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reason"
          },
          "bandwidth_limited_until": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Bandwidth Limited Until"
          },
          "manual_limited_until": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Manual Limited Until"
          }
        },
        "required": [
          "limit_mbps",
          "reason",
          "bandwidth_limited_until"
        ],
        "title": "TrafficShaping",
        "type": "object"
      },
      "TransactionItem": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "transaction_type": {
            "type": "string",
            "enum": [
              "topup",
              "vm_purchase",
              "vm_renewal",
              "vm_resize",
              "traffic_purchase",
              "ipv4_purchase",
              "ipv4_renewal",
              "dedicated_purchase",
              "dedicated_renewal",
              "backup_purchase",
              "backup_renewal",
              "refund",
              "adjustment",
              "mail_purchase",
              "mail_renewal",
              "mail_upgrade"
            ],
            "title": "Transaction Type"
          },
          "amount_usd": {
            "type": "string",
            "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
            "title": "Amount Usd",
            "description": "USD decimal string with four fractional digits; transaction amounts retain their sign."
          },
          "balance_before": {
            "type": "string",
            "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
            "title": "Balance Before"
          },
          "balance_after": {
            "type": "string",
            "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
            "title": "Balance After"
          },
          "order_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Order Id"
          },
          "comment": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Comment"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          }
        },
        "type": "object",
        "required": [
          "id",
          "transaction_type",
          "amount_usd",
          "balance_before",
          "balance_after",
          "order_id",
          "comment",
          "created_at"
        ],
        "title": "TransactionItem"
      },
      "TransactionListResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/TransactionItem"
            },
            "type": "array",
            "title": "Data"
          },
          "total_count": {
            "type": "integer",
            "title": "Total Count",
            "description": "Full matching count before pagination."
          },
          "currency": {
            "type": "string",
            "const": "USD",
            "title": "Currency",
            "default": "USD"
          },
          "limit": {
            "type": "integer",
            "title": "Limit",
            "description": "Maximum number of records in this page."
          },
          "offset": {
            "type": "integer",
            "title": "Offset",
            "description": "Number of records to skip, starting from zero."
          }
        },
        "type": "object",
        "required": [
          "success",
          "data",
          "total_count",
          "limit",
          "offset"
        ],
        "title": "TransactionListResponse",
        "example": {
          "success": true,
          "data": [
            {
              "id": 1,
              "transaction_type": "topup",
              "amount_usd": "5.0000",
              "balance_before": "100.0000",
              "balance_after": "95.0000",
              "order_id": null,
              "comment": null,
              "created_at": "2026-09-28T12:00:00Z"
            }
          ],
          "total_count": 1,
          "currency": "USD",
          "limit": 25,
          "offset": 0
        }
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "VmAutoRenewData": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "title": "Vm Id"
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "auto_renew"
        ],
        "title": "VmAutoRenewData"
      },
      "VmAutoRenewResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/VmAutoRenewData"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "VmAutoRenewResponse",
        "example": {
          "success": true,
          "data": {
            "vm_id": 101,
            "auto_renew": false
          }
        }
      },
      "VmConsoleLink": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "title": "Vm Id"
          },
          "url": {
            "type": "string",
            "title": "Url"
          },
          "expires_at": {
            "type": "string",
            "format": "date-time",
            "title": "Expires At"
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "url",
          "expires_at"
        ],
        "title": "VmConsoleLink"
      },
      "VmConsoleLinkResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/VmConsoleLink"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "VmConsoleLinkResponse",
        "example": {
          "success": true,
          "data": {
            "vm_id": 101,
            "url": "https://console.example.com/session/example",
            "expires_at": "2026-09-28T12:00:00Z"
          }
        }
      },
      "VmCreateRequest": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "api_user_id": {
            "type": "string",
            "maxLength": 255,
            "minLength": 1,
            "pattern": "\\S",
            "title": "Api User Id",
            "description": "Your customer identifier. Stored as a string; scoped to this integration."
          },
          "location_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Location Id"
          },
          "platform": {
            "type": "string",
            "enum": [
              "epyc",
              "ryzen",
              "xeon"
            ],
            "title": "Platform"
          },
          "plan_code": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
            "title": "Plan Code",
            "description": "VPS plan code from GET /plans."
          },
          "cpu_percent": {
            "type": "integer",
            "enum": [
              20,
              40,
              60,
              80,
              100
            ],
            "title": "Cpu Percent",
            "default": 60,
            "description": "CPU share: 20, 40, 60, 80 or 100. Creation defaults to 60; resize keeps the current share if omitted."
          },
          "os_id": {
            "anyOf": [
              {
                "type": "integer",
                "maximum": 9.223372036854776e+18,
                "minimum": 1.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Os Id",
            "description": "Operating system ID from GET /reference/os. Required for a normal installation; omit when supplying backup_id."
          },
          "months": {
            "type": "integer",
            "enum": [
              1,
              3,
              6,
              12,
              24,
              36
            ],
            "title": "Months",
            "default": 1,
            "description": "Calendar months: 1, 3, 6, 12, 24 or 36. JSON integer."
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "default": false,
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{1,11}\\.\\d{4}$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expected Amount Usd",
            "description": "Optional confirmed price in USD, exactly four decimal places. A changed price returns 409 price_changed before charging. For a resize this is the maximum accepted price."
          },
          "hostname": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 63,
                "minLength": 1,
                "pattern": "^[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Hostname",
            "description": "Optional hostname. When omitted or null, the server service assigns vm-{vm_id} using the VPS ID, not the order ID. An explicitly supplied hostname is preserved. For Windows: at most 15 characters and not digits only."
          },
          "password": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 1024,
                "minLength": 1
              },
              {
                "type": "null"
              }
            ],
            "title": "Password",
            "description": "Access password. Never send together with ssh_public_key. For Windows installation: 8–127 characters, at least three character categories (lowercase, uppercase, digits, special characters), no CR/LF/NUL or login substring.",
            "writeOnly": true
          },
          "ssh_public_key": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 8192,
                "minLength": 1
              },
              {
                "type": "null"
              }
            ],
            "title": "Ssh Public Key",
            "description": "One OpenSSH public-key line: Ed25519, RSA or ECDSA. Send the key itself, not a saved key ID. Not supported for Windows."
          },
          "cloud_init": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Cloud Init",
            "description": "Optional cloud-config JSON object, not a YAML string. Maximum 65536 bytes after server JSON serialization (non-ASCII characters are escaped). users, packages, runcmd and write_files must be arrays when present. Networking, hostname and primary access are managed by the platform. Retain the same object when retrying. Its result is reported separately in guest_initialization; cloud_init contents are not returned in orders or webhooks. Not supported for Windows."
          },
          "application_id": {
            "anyOf": [
              {
                "maximum": 9223372036854775807,
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Application Id",
            "description": "Optional application_id selects an application from GET /reference/applications. Keep os_id and exactly one access method. Do not combine application_id with a non-null cloud_init, including {}. Availability, OS and resource compatibility are checked during provisioning by the server service; Cloud API does not duplicate those checks. A rejected creation is handled by the existing order refund flow. Quotes calculate the VPS price only and do not confirm application compatibility. Applications do not add a separate charge. Keep application_id unchanged when retrying the same Idempotency-Key. Not supported for Windows."
          },
          "backup_id": {
            "anyOf": [
              {
                "type": "integer",
                "maximum": 9.223372036854776e+18,
                "minimum": 1.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Backup Id",
            "description": "To create a new VPS from a paid backup, supply backup_id instead of os_id. Omit password, ssh_public_key, application_id and cloud_init: OS, programs and access come from the copy. Keep the same api_user_id as the backup owner. The new VPS receives its own addresses and is billed as a normal vm_purchase with the usual plan markup and term discount. Restore itself has no separate fee and shares the 3-per-service/24-hour restore limit. The selected disk must fit all backed-up disks; compatibility is checked by the server service."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "api_user_id",
          "location_id",
          "platform",
          "plan_code"
        ],
        "title": "VmCreateRequest",
        "example": {
          "api_key_id": 1,
          "api_user_id": "customer-123",
          "location_id": 1,
          "platform": "epyc",
          "plan_code": "C1",
          "cpu_percent": 60,
          "os_id": 1,
          "months": 1,
          "auto_renew": false,
          "password": "Example-Password-2026!",
          "cloud_init": {
            "packages": [
              "curl"
            ],
            "runcmd": [
              [
                "sh",
                "-c",
                "echo ready > /root/cloud-init-ready"
              ]
            ]
          }
        }
      },
      "VmDeleteResult": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Vm Id"
          },
          "status": {
            "type": "string",
            "const": "deleted",
            "title": "Status"
          },
          "keep_ips": {
            "type": "boolean",
            "title": "Keep Ips",
            "description": "Explicitly retain IPv4 as separately billed addresses (true) or release them (false)."
          },
          "held_ips": {
            "items": {
              "$ref": "#/components/schemas/HeldIpv4"
            },
            "type": "array",
            "title": "Held Ips"
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "status",
          "keep_ips",
          "held_ips"
        ],
        "title": "VmDeleteResult"
      },
      "VmFirewall": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "title": "Vm Id"
          },
          "revision": {
            "type": "integer",
            "minimum": 0.0,
            "title": "Revision",
            "description": "Current firewall revision from GET firewall. Reread on conflict."
          },
          "applied": {
            "type": "boolean",
            "title": "Applied"
          },
          "input_policy": {
            "type": "string",
            "enum": [
              "ACCEPT",
              "DROP"
            ],
            "title": "Input Policy"
          },
          "output_policy": {
            "type": "string",
            "enum": [
              "ACCEPT",
              "DROP"
            ],
            "title": "Output Policy"
          },
          "rules": {
            "items": {
              "$ref": "#/components/schemas/FirewallRuleItem"
            },
            "type": "array",
            "title": "Rules"
          },
          "smtp_ports": {
            "items": {
              "type": "integer"
            },
            "type": "array",
            "title": "Smtp Ports"
          },
          "smtp_blocked": {
            "type": "boolean",
            "title": "Smtp Blocked"
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "revision",
          "applied",
          "input_policy",
          "output_policy",
          "rules",
          "smtp_ports",
          "smtp_blocked"
        ],
        "title": "VmFirewall"
      },
      "VmFirewallResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/VmFirewall"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "VmFirewallResponse",
        "example": {
          "success": true,
          "data": {
            "vm_id": 101,
            "revision": 0,
            "applied": true,
            "input_policy": "ACCEPT",
            "output_policy": "ACCEPT",
            "rules": [
              {
                "direction": "IN",
                "action": "ACCEPT",
                "protocol": "tcp",
                "ports": [
                  "443"
                ],
                "source": null,
                "destination": null,
                "enabled": true,
                "comment": "HTTPS",
                "id": 1
              }
            ],
            "smtp_ports": [
              1
            ],
            "smtp_blocked": true
          }
        }
      },
      "VmGetResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/VmItem"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "VmGetResponse",
        "example": {
          "success": true,
          "data": {
            "id": 1,
            "name": "Example",
            "hostname": "customer-vps",
            "status": "example",
            "cpu_cores": 1,
            "cpu_percent": 60,
            "ram_mb": 1,
            "disk_gb": 1,
            "smtp_blocked": true,
            "paid_until": null,
            "created_at": "2026-09-28T12:00:00Z",
            "updated_at": null,
            "ips": [
              {
                "ip_id": 301,
                "address": "192.0.2.10",
                "family": 4,
                "is_rf_blocked": true,
                "assigned_at": null,
                "is_primary": true,
                "paid_until": null,
                "suspended_at": null,
                "auto_renew": null
              }
            ],
            "auto_renew": false,
            "api_user_id": "customer-123",
            "plan_code": "C1",
            "platform": "epyc",
            "cpu_display_name": "AMD EPYC 7502P",
            "location_id": 1,
            "location_name": "Poland",
            "country_code": "PL",
            "datacenter": null,
            "city": "example",
            "os": null,
            "guest_initialization": {
              "status": "succeeded",
              "error_code": null
            },
            "rescue": {
              "active": false,
              "access": null,
              "requires_review": false,
              "operation_id": null,
              "operation_status": null
            },
            "cpu_max_frequency_ghz": 3.35
          }
        }
      },
      "VmIp": {
        "properties": {
          "ip_id": {
            "type": "integer",
            "title": "Ip Id"
          },
          "address": {
            "type": "string",
            "title": "Address"
          },
          "family": {
            "type": "integer",
            "enum": [
              4,
              6
            ],
            "title": "Family"
          },
          "is_rf_blocked": {
            "type": "boolean",
            "title": "Is Rf Blocked"
          },
          "assigned_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Assigned At"
          },
          "is_primary": {
            "type": "boolean",
            "title": "Is Primary"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until",
            "description": "End of the paid service term, UTC."
          },
          "suspended_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Suspended At"
          },
          "auto_renew": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Auto Renew",
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          }
        },
        "type": "object",
        "required": [
          "ip_id",
          "address",
          "family",
          "is_rf_blocked",
          "assigned_at",
          "is_primary",
          "paid_until",
          "suspended_at"
        ],
        "title": "VmIp"
      },
      "VmIpAttachResult": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Vm Id"
          },
          "status": {
            "type": "string",
            "enum": [
              "running",
              "stopped"
            ],
            "title": "Status"
          },
          "ip_id": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Ip Id"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until",
            "description": "End of the paid service term, UTC."
          },
          "addresses": {
            "items": {
              "type": "string",
              "format": "ipvanyinterface"
            },
            "type": "array",
            "title": "Addresses"
          },
          "guest_configuration_required": {
            "type": "boolean",
            "const": true,
            "title": "Guest Configuration Required",
            "description": "If true, update IP configuration inside the guest OS."
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "status",
          "ip_id",
          "paid_until",
          "addresses",
          "guest_configuration_required"
        ],
        "title": "VmIpAttachResult"
      },
      "VmIpDetachResult": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Vm Id"
          },
          "status": {
            "type": "string",
            "enum": [
              "running",
              "stopped"
            ],
            "title": "Status"
          },
          "detached_ip_id": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Detached Ip Id"
          },
          "keep_ip": {
            "type": "boolean",
            "title": "Keep Ip",
            "description": "Keep the detached IPv4 with continuing billing (true) or release it (false)."
          },
          "addresses": {
            "items": {
              "type": "string",
              "format": "ipvanyinterface"
            },
            "type": "array",
            "title": "Addresses"
          },
          "guest_configuration_required": {
            "type": "boolean",
            "const": true,
            "title": "Guest Configuration Required",
            "description": "If true, update IP configuration inside the guest OS."
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "status",
          "detached_ip_id",
          "keep_ip",
          "addresses",
          "guest_configuration_required"
        ],
        "title": "VmIpDetachResult"
      },
      "VmIpv4PurchaseBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{1,11}\\.\\d{4}$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expected Amount Usd",
            "description": "Optional confirmed price in USD, exactly four decimal places. A changed price returns 409 price_changed before charging. For a resize this is the maximum accepted price."
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "default": false,
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          },
          "months": {
            "type": "integer",
            "enum": [
              1,
              3,
              6,
              12,
              24,
              36
            ],
            "default": 1,
            "description": "Calendar months: 1, 3, 6, 12, 24 or 36. Defaults to 1. The IP term is independent of the VPS term."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id"
        ],
        "title": "VmIpv4PurchaseBody",
        "example": {
          "api_key_id": 1,
          "auto_renew": false,
          "months": 1
        }
      },
      "VmItem": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "hostname": {
            "type": "string",
            "title": "Hostname"
          },
          "status": {
            "type": "string",
            "title": "Status"
          },
          "cpu_cores": {
            "type": "integer",
            "title": "Cpu Cores"
          },
          "cpu_percent": {
            "type": "number",
            "title": "Cpu Percent",
            "description": "CPU share: 20, 40, 60, 80 or 100. Creation defaults to 60; resize keeps the current share if omitted."
          },
          "ram_mb": {
            "type": "integer",
            "title": "Ram Mb"
          },
          "disk_gb": {
            "type": "integer",
            "title": "Disk Gb"
          },
          "smtp_blocked": {
            "type": "boolean",
            "title": "Smtp Blocked"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until",
            "description": "End of the paid service term, UTC."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "updated_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Updated At"
          },
          "ips": {
            "items": {
              "$ref": "#/components/schemas/VmIp"
            },
            "type": "array",
            "title": "Ips"
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          },
          "api_user_id": {
            "type": "string",
            "title": "Api User Id",
            "description": "Your customer identifier. Stored as a string; scoped to this integration."
          },
          "plan_code": {
            "type": "string",
            "title": "Plan Code",
            "description": "VPS plan code from GET /plans."
          },
          "platform": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "epyc",
                  "ryzen",
                  "xeon"
                ]
              },
              {
                "type": "null"
              }
            ],
            "title": "Platform",
            "description": "CPU family of the current node; null when not specified."
          },
          "cpu_display_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cpu Display Name",
            "description": "Physical CPU model of the current node, as stored; null when unknown. Any core/thread counts in this text describe the physical processor, not allocated vCPU."
          },
          "location_id": {
            "type": "integer",
            "title": "Location Id"
          },
          "location_name": {
            "type": "string",
            "title": "Location Name"
          },
          "country_code": {
            "type": "string",
            "title": "Country Code"
          },
          "datacenter": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Datacenter",
            "description": "Location datacenter name; null if not specified."
          },
          "city": {
            "type": "string",
            "title": "City"
          },
          "os": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/VmOs"
              },
              {
                "type": "null"
              }
            ]
          },
          "rescue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/VmRescueState"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Rescue state. active means a saved Rescue context, not guaranteed SSH availability. access is ssh, console or null. requires_review calls for state verification; operation_id and operation_status refer to the Rescue operation. null means no state was returned."
          },
          "guest_initialization": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/VmGuestInitialization"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Latest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health."
          },
          "application": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ApplicationItem"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Application snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation."
          },
          "login": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Login",
            "description": "login is the actual installation user, normally admin for Windows or root for Linux; null means the login is unknown. Passwords are not returned."
          },
          "cpu_max_frequency_ghz": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cpu Max Frequency Ghz",
            "description": "Maximum physical CPU frequency of the current node in GHz; null when unknown. Not a current or guaranteed vCPU frequency."
          },
          "admin_blocked_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Administrative block time in UTC; null means no block."
          },
          "admin_block_reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Customer-visible block reason, or null."
          }
        },
        "type": "object",
        "required": [
          "id",
          "name",
          "hostname",
          "status",
          "cpu_cores",
          "cpu_percent",
          "ram_mb",
          "disk_gb",
          "smtp_blocked",
          "paid_until",
          "created_at",
          "updated_at",
          "ips",
          "auto_renew",
          "api_user_id",
          "plan_code",
          "platform",
          "cpu_display_name",
          "location_id",
          "location_name",
          "country_code",
          "datacenter",
          "city",
          "os"
        ],
        "title": "VmItem"
      },
      "VmListItem": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "api_user_id": {
            "type": "string",
            "title": "Api User Id",
            "description": "Your customer identifier. Stored as a string; scoped to this integration."
          },
          "name": {
            "type": "string",
            "title": "Name"
          },
          "status": {
            "type": "string",
            "title": "Status"
          },
          "plan_code": {
            "type": "string",
            "title": "Plan Code",
            "description": "VPS plan code from GET /plans."
          },
          "cpu_cores": {
            "type": "integer",
            "title": "Cpu Cores"
          },
          "cpu_percent": {
            "type": "number",
            "title": "Cpu Percent",
            "description": "CPU share: 20, 40, 60, 80 or 100. Creation defaults to 60; resize keeps the current share if omitted."
          },
          "ram_mb": {
            "type": "integer",
            "title": "Ram Mb"
          },
          "disk_gb": {
            "type": "integer",
            "title": "Disk Gb"
          },
          "location_id": {
            "type": "integer",
            "title": "Location Id"
          },
          "location_name": {
            "type": "string",
            "title": "Location Name"
          },
          "country_code": {
            "type": "string",
            "title": "Country Code"
          },
          "datacenter": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Datacenter",
            "description": "Location datacenter name; null if not specified."
          },
          "platform": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "epyc",
                  "ryzen",
                  "xeon"
                ]
              },
              {
                "type": "null"
              }
            ],
            "title": "Platform",
            "description": "CPU family of the current node; null when not specified."
          },
          "ips": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Ips"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until",
            "description": "End of the paid service term, UTC."
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "description": "Automatic renewal from the integration balance. Changing this flag does not extend the service immediately."
          },
          "application": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ApplicationItem"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Application snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation."
          },
          "cpu_display_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cpu Display Name",
            "description": "Physical CPU model of the current node, as stored; null when unknown. Any core/thread counts in this text describe the physical processor, not allocated vCPU."
          },
          "cpu_max_frequency_ghz": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cpu Max Frequency Ghz",
            "description": "Maximum physical CPU frequency of the current node in GHz; null when unknown. Not a current or guaranteed vCPU frequency."
          },
          "admin_blocked_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Administrative block time in UTC; null means no block."
          },
          "admin_block_reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Customer-visible block reason, or null."
          },
          "city": {
            "type": "string",
            "description": "VM location city."
          },
          "os_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Current OS code, including successful reinstallation and backup restoration."
          },
          "primary_ipv4": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Explicit primary IPv4 allocation, or null."
          }
        },
        "type": "object",
        "required": [
          "id",
          "api_user_id",
          "name",
          "status",
          "plan_code",
          "cpu_cores",
          "cpu_percent",
          "ram_mb",
          "disk_gb",
          "location_id",
          "location_name",
          "country_code",
          "datacenter",
          "platform",
          "ips",
          "paid_until",
          "auto_renew",
          "cpu_display_name",
          "cpu_max_frequency_ghz",
          "city",
          "os_code",
          "primary_ipv4"
        ],
        "title": "VmListItem"
      },
      "VmListResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/VmListItem"
            },
            "type": "array",
            "title": "Data"
          },
          "total_count": {
            "type": "integer",
            "title": "Total Count",
            "description": "Full matching count before pagination."
          }
        },
        "type": "object",
        "required": [
          "success",
          "data",
          "total_count"
        ],
        "title": "VmListResponse",
        "example": {
          "success": true,
          "data": [
            {
              "id": 1,
              "api_user_id": "customer-123",
              "name": "Example",
              "status": "example",
              "plan_code": "C1",
              "cpu_cores": 1,
              "cpu_percent": 60,
              "ram_mb": 1,
              "disk_gb": 1,
              "location_id": 1,
              "location_name": "Poland",
              "country_code": "PL",
              "datacenter": null,
              "platform": "epyc",
              "ips": [
                "example"
              ],
              "paid_until": null,
              "auto_renew": false,
              "cpu_display_name": "AMD EPYC 7502P",
              "cpu_max_frequency_ghz": 3.35
            }
          ],
          "total_count": 1
        }
      },
      "VmMetrics": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "title": "Vm Id"
          },
          "timeframe": {
            "type": "string",
            "enum": [
              "hour",
              "day",
              "week",
              "month",
              "year"
            ],
            "title": "Timeframe"
          },
          "cf": {
            "type": "string",
            "enum": [
              "AVERAGE",
              "MAX"
            ],
            "title": "Cf"
          },
          "points": {
            "items": {
              "$ref": "#/components/schemas/MetricPoint"
            },
            "type": "array",
            "title": "Points"
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "timeframe",
          "cf",
          "points"
        ],
        "title": "VmMetrics"
      },
      "VmMetricsResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/VmMetrics"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "VmMetricsResponse",
        "example": {
          "success": true,
          "data": {
            "vm_id": 101,
            "timeframe": "hour",
            "cf": "AVERAGE",
            "points": [
              {
                "time": 1790596800,
                "cpu_percent": null,
                "memory_used_bytes": null,
                "memory_total_bytes": null,
                "network_in_mbps": null,
                "network_out_mbps": null,
                "disk_read_bytes_per_second": null,
                "disk_write_bytes_per_second": null
              }
            ]
          }
        }
      },
      "VmOperation": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "vm_id": {
            "type": "integer",
            "title": "Vm Id"
          },
          "action": {
            "enum": [
              "power",
              "delete",
              "ip_attach",
              "ip_detach",
              "firewall_add",
              "firewall_update",
              "firewall_delete",
              "firewall_reorder",
              "firewall_policies",
              "firewall_smtp",
              "password_reset",
              "reinstall",
              "rescue_enable",
              "rescue_disable",
              "admin_block",
              "admin_unblock"
            ],
            "title": "Action",
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "queued",
              "running",
              "succeeded",
              "failed"
            ],
            "title": "Status"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "started_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Started At"
          },
          "finished_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Finished At"
          },
          "error_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Code",
            "description": "Error code. vm_admin_blocked means an administrative block denied the action; contact support."
          },
          "error_message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Message"
          },
          "result": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/VmDeleteResult"
              },
              {
                "$ref": "#/components/schemas/VmIpAttachResult"
              },
              {
                "$ref": "#/components/schemas/VmIpDetachResult"
              },
              {
                "$ref": "#/components/schemas/PasswordResetResult"
              },
              {
                "$ref": "#/components/schemas/ReinstallResult"
              },
              {
                "$ref": "#/components/schemas/RescueResult"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Result"
          },
          "requires_review": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Requires Review",
            "description": "The operation outcome needs clarification before another destructive action."
          }
        },
        "type": "object",
        "required": [
          "id",
          "vm_id",
          "action",
          "status",
          "created_at",
          "started_at",
          "finished_at"
        ],
        "title": "VmOperation"
      },
      "VmOperationHistoryItem": {
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Id"
          },
          "vm_id": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Vm Id"
          },
          "action": {
            "type": "string",
            "title": "Action"
          },
          "status": {
            "type": "string",
            "enum": [
              "queued",
              "running",
              "succeeded",
              "failed",
              "cancelled"
            ],
            "title": "Status"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "started_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Started At"
          },
          "finished_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Finished At"
          },
          "attempts": {
            "type": "integer",
            "minimum": 0.0,
            "title": "Attempts"
          },
          "order_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Order Id"
          },
          "power_action": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "start",
                  "shutdown",
                  "reboot",
                  "stop",
                  "reset"
                ]
              },
              {
                "type": "null"
              }
            ],
            "title": "Power Action"
          },
          "requires_review": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Requires Review",
            "description": "The operation outcome needs clarification before another destructive action."
          },
          "error_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Code",
            "description": "Error code. vm_admin_blocked means an administrative block denied the action; contact support."
          },
          "error_message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Message"
          }
        },
        "type": "object",
        "required": [
          "id",
          "vm_id",
          "action",
          "status",
          "created_at",
          "started_at",
          "finished_at",
          "attempts"
        ],
        "title": "VmOperationHistoryItem"
      },
      "VmOperationListResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/VmOperationHistoryItem"
            },
            "type": "array",
            "title": "Data"
          },
          "total_count": {
            "type": "integer",
            "title": "Total Count",
            "description": "Full matching count before pagination."
          }
        },
        "type": "object",
        "required": [
          "success",
          "data",
          "total_count"
        ],
        "title": "VmOperationListResponse",
        "example": {
          "success": true,
          "data": [
            {
              "id": 1,
              "vm_id": 101,
              "action": "start",
              "status": "queued",
              "created_at": "2026-09-28T12:00:00Z",
              "started_at": null,
              "finished_at": null,
              "attempts": 1,
              "order_id": null,
              "power_action": null,
              "requires_review": null,
              "error_code": null,
              "error_message": null
            }
          ],
          "total_count": 1
        }
      },
      "VmOperationResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/VmOperation"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "VmOperationResponse",
        "example": {
          "success": true,
          "data": {
            "id": 1,
            "vm_id": 101,
            "action": "power",
            "status": "queued",
            "created_at": "2026-09-28T12:00:00Z",
            "started_at": null,
            "finished_at": null,
            "error_code": null,
            "error_message": null,
            "result": null,
            "requires_review": null
          }
        }
      },
      "VmOs": {
        "properties": {
          "id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Id"
          },
          "code": {
            "type": "string",
            "title": "Code"
          },
          "name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Name"
          }
        },
        "type": "object",
        "required": [
          "id",
          "code",
          "name"
        ],
        "title": "VmOs"
      },
      "VmPowerBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "action": {
            "type": "string",
            "enum": [
              "start",
              "shutdown",
              "reboot",
              "stop",
              "reset"
            ],
            "title": "Action"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "action"
        ],
        "title": "VmPowerBody",
        "example": {
          "api_key_id": 1,
          "action": "start"
        }
      },
      "VmRenewBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "months": {
            "type": "integer",
            "enum": [
              1,
              3,
              6,
              12,
              24,
              36
            ],
            "title": "Months",
            "default": 1,
            "description": "Calendar months: 1, 3, 6, 12, 24 or 36. JSON integer."
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{1,11}\\.\\d{4}$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expected Amount Usd",
            "description": "Optional confirmed price in USD, exactly four decimal places. A changed price returns 409 price_changed before charging. For a resize this is the maximum accepted price."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id"
        ],
        "title": "VmRenewBody",
        "example": {
          "api_key_id": 1,
          "months": 1
        }
      },
      "VmResizeBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{1,11}\\.\\d{4}$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expected Amount Usd",
            "description": "Optional confirmed price in USD, exactly four decimal places. A changed price returns 409 price_changed before charging. For a resize this is the maximum accepted price."
          },
          "plan_code": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
            "title": "Plan Code",
            "description": "VPS plan code from GET /plans."
          },
          "cpu_percent": {
            "anyOf": [
              {
                "type": "integer",
                "enum": [
                  20,
                  40,
                  60,
                  80,
                  100
                ]
              },
              {
                "type": "null"
              }
            ],
            "title": "Cpu Percent",
            "description": "CPU share: 20, 40, 60, 80 or 100. Creation defaults to 60; resize keeps the current share if omitted."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "plan_code"
        ],
        "title": "VmResizeBody",
        "example": {
          "api_key_id": 1,
          "plan_code": "C1"
        }
      },
      "VmStatus": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "title": "Vm Id"
          },
          "status": {
            "type": "string",
            "title": "Status"
          },
          "uptime": {
            "type": "integer",
            "title": "Uptime"
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "status",
          "uptime"
        ],
        "title": "VmStatus"
      },
      "VmStatusResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/VmStatus"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "VmStatusResponse",
        "example": {
          "success": true,
          "data": {
            "vm_id": 101,
            "status": "example",
            "uptime": 1
          }
        }
      },
      "VmTraffic": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "title": "Vm Id"
          },
          "enabled": {
            "type": "boolean",
            "title": "Enabled"
          },
          "period": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/TrafficPeriod"
              },
              {
                "type": "null"
              }
            ]
          },
          "last_sample_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Sample At"
          },
          "shaping": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/TrafficShaping"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "enabled",
          "period",
          "last_sample_at"
        ],
        "title": "VmTraffic"
      },
      "VmTrafficResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/VmTraffic"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "VmTrafficResponse",
        "example": {
          "success": true,
          "data": {
            "vm_id": 101,
            "enabled": true,
            "period": null,
            "last_sample_at": null,
            "shaping": null
          }
        }
      },
      "VmTrafficTopupBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{1,11}\\.\\d{4}$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expected Amount Usd",
            "description": "Optional confirmed price in USD, exactly four decimal places. A changed price returns 409 price_changed before charging. For a resize this is the maximum accepted price."
          },
          "expected_period_id": {
            "anyOf": [
              {
                "type": "integer",
                "maximum": 9.223372036854776e+18,
                "minimum": 1.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Expected Period Id",
            "description": "Traffic period ID from the quote. A changed period returns 409 quote_expired."
          },
          "traffic_tb": {
            "type": "integer",
            "maximum": 8388607.0,
            "minimum": 1.0,
            "title": "Traffic Tb",
            "description": "Additional integer traffic units; one unit is 1024⁴ bytes."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "traffic_tb"
        ],
        "title": "VmTrafficTopupBody",
        "example": {
          "api_key_id": 1,
          "traffic_tb": 1
        }
      },
      "TermQuoteResponse": {
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "object",
            "required": [
              "amount_usd",
              "balance_usd",
              "currency",
              "months",
              "discount_percent"
            ],
            "properties": {
              "amount_usd": {
                "type": "string",
                "pattern": "^\\d+\\.\\d{4}$"
              },
              "balance_usd": {
                "type": "string",
                "pattern": "^\\d+\\.\\d{4}$"
              },
              "currency": {
                "type": "string",
                "const": "USD"
              },
              "months": {
                "type": "integer"
              },
              "discount_percent": {
                "type": "string"
              }
            }
          }
        },
        "example": {
          "success": true,
          "data": {
            "amount_usd": "5.0000",
            "balance_usd": "100.0000",
            "currency": "USD",
            "months": 1,
            "discount_percent": "0"
          }
        }
      },
      "ResizeQuoteResponse": {
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "object",
            "required": [
              "amount_usd",
              "balance_usd",
              "currency",
              "vm_id",
              "new_monthly_price_usd",
              "paid_until"
            ],
            "properties": {
              "amount_usd": {
                "type": "string",
                "pattern": "^\\d+\\.\\d{4}$"
              },
              "balance_usd": {
                "type": "string",
                "pattern": "^\\d+\\.\\d{4}$"
              },
              "currency": {
                "type": "string",
                "const": "USD"
              },
              "vm_id": {
                "type": "integer"
              },
              "new_monthly_price_usd": {
                "type": "string",
                "pattern": "^\\d+\\.\\d{4}$"
              },
              "paid_until": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "example": {
          "success": true,
          "data": {
            "amount_usd": "5.0000",
            "balance_usd": "100.0000",
            "currency": "USD",
            "vm_id": 101,
            "new_monthly_price_usd": "10.0000",
            "paid_until": "2026-09-28T12:00:00Z"
          }
        }
      },
      "TrafficQuoteResponse": {
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "object",
            "required": [
              "amount_usd",
              "balance_usd",
              "currency",
              "vm_id",
              "unit_price_usd",
              "expected_period_id",
              "period_ends_at"
            ],
            "properties": {
              "amount_usd": {
                "type": "string",
                "pattern": "^\\d+\\.\\d{4}$"
              },
              "balance_usd": {
                "type": "string",
                "pattern": "^\\d+\\.\\d{4}$"
              },
              "currency": {
                "type": "string",
                "const": "USD"
              },
              "vm_id": {
                "type": "integer"
              },
              "unit_price_usd": {
                "type": "string",
                "pattern": "^\\d+\\.\\d{4}$"
              },
              "expected_period_id": {
                "type": "integer"
              },
              "period_ends_at": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "example": {
          "success": true,
          "data": {
            "amount_usd": "5.0000",
            "balance_usd": "100.0000",
            "currency": "USD",
            "vm_id": 101,
            "unit_price_usd": "1.0000",
            "expected_period_id": 601,
            "period_ends_at": "2026-09-28T12:00:00Z"
          }
        }
      },
      "Ipv4QuoteResponse": {
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "object",
            "required": [
              "amount_usd",
              "balance_usd",
              "currency",
              "vm_id",
              "months",
              "monthly_price_usd"
            ],
            "properties": {
              "amount_usd": {
                "type": "string",
                "pattern": "^\\d+\\.\\d{4}$"
              },
              "balance_usd": {
                "type": "string",
                "pattern": "^\\d+\\.\\d{4}$"
              },
              "currency": {
                "type": "string",
                "const": "USD"
              },
              "vm_id": {
                "type": "integer"
              },
              "months": {
                "type": "integer",
                "enum": [
                  1,
                  3,
                  6,
                  12,
                  24,
                  36
                ],
                "description": "Calendar months: 1, 3, 6, 12, 24 or 36. Defaults to 1. The IP term is independent of the VPS term."
              },
              "monthly_price_usd": {
                "type": "string",
                "pattern": "^\\d+\\.\\d{4}$",
                "description": "Fixed monthly IPv4 rate in USD, without markup or discount."
              }
            }
          }
        },
        "example": {
          "success": true,
          "data": {
            "amount_usd": "5.0000",
            "balance_usd": "100.0000",
            "currency": "USD",
            "vm_id": 101,
            "months": 1,
            "monthly_price_usd": "5.0000"
          }
        }
      },
      "RentalAutoRenewResponse": {
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "object",
            "required": [
              "rental_id",
              "auto_renew"
            ],
            "properties": {
              "rental_id": {
                "type": "integer"
              },
              "auto_renew": {
                "type": "boolean"
              }
            }
          }
        },
        "example": {
          "success": true,
          "data": {
            "rental_id": 201,
            "auto_renew": false
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "required": [
          "detail"
        ],
        "properties": {
          "detail": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "object",
                "additionalProperties": true
              },
              {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            ]
          }
        }
      },
      "VmGuestInitialization": {
        "properties": {
          "status": {
            "enum": [
              "succeeded",
              "failed",
              "unknown"
            ],
            "title": "Status",
            "type": "string"
          },
          "error_code": {
            "anyOf": [
              {
                "enum": [
                  "cloud_init_failed",
                  "guest_initialization_timeout"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Error Code"
          }
        },
        "required": [
          "status"
        ],
        "title": "VmGuestInitialization",
        "type": "object",
        "description": "Latest installation result: succeeded means cloud-init finished; failed / cloud_init_failed means custom configuration failed; unknown / guest_initialization_timeout means the result was not confirmed within 15 minutes. failed and unknown do not mean a running VPS was not created: its order may be completed and reinstallation succeeded. null means no result is available. Does not confirm application health.",
        "example": {
          "status": "succeeded",
          "error_code": null
        }
      },
      "VmRescueState": {
        "properties": {
          "active": {
            "title": "Active",
            "type": "boolean"
          },
          "access": {
            "anyOf": [
              {
                "enum": [
                  "console",
                  "ssh"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Access"
          },
          "requires_review": {
            "title": "Requires Review",
            "type": "boolean"
          },
          "operation_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Operation Id"
          },
          "operation_status": {
            "anyOf": [
              {
                "enum": [
                  "queued",
                  "running",
                  "succeeded",
                  "failed",
                  "cancelled"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Operation Status"
          }
        },
        "required": [
          "active",
          "requires_review"
        ],
        "title": "VmRescueState",
        "type": "object",
        "description": "Rescue state. active means a saved Rescue context, not guaranteed SSH availability. access is ssh, console or null. requires_review calls for state verification; operation_id and operation_status refer to the Rescue operation. null means no state was returned.",
        "example": {
          "active": true,
          "access": "ssh",
          "requires_review": false,
          "operation_id": 501,
          "operation_status": "succeeded"
        }
      },
      "RescueEnableBody": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "maximum": 9223372036854775807,
            "minimum": 1,
            "title": "Api Key Id",
            "type": "integer"
          },
          "password": {
            "maxLength": 128,
            "minLength": 5,
            "pattern": "^[^\\r\\n\\x00]+$",
            "title": "Password",
            "type": "string",
            "description": "Temporary root SSH password for Rescue: 5–128 characters, without CR, LF or NUL. Supplied by the client."
          }
        },
        "required": [
          "api_key_id",
          "password"
        ],
        "title": "RescueEnableBody",
        "type": "object",
        "example": {
          "api_key_id": 1,
          "password": "Temporary-Rescue-2026!"
        }
      },
      "RescueResult": {
        "properties": {
          "vm_id": {
            "title": "Vm Id",
            "type": "integer"
          },
          "status": {
            "enum": [
              "running",
              "stopped"
            ],
            "title": "Status",
            "type": "string"
          },
          "rescue": {
            "$ref": "#/components/schemas/VmRescueState"
          }
        },
        "required": [
          "vm_id",
          "status",
          "rescue"
        ],
        "title": "RescueResult",
        "type": "object",
        "example": {
          "vm_id": 101,
          "status": "running",
          "rescue": {
            "active": true,
            "access": "ssh",
            "requires_review": false,
            "operation_id": 501,
            "operation_status": "succeeded"
          }
        }
      },
      "DedicatedLayout": {
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "separate",
              "lvm_linear",
              "raid0",
              "raid1"
            ],
            "title": "Code",
            "description": "Code for disk_layout or a value in disk_layouts when purchasing or quoting."
          },
          "name": {
            "type": "string",
            "title": "Name",
            "description": "Display name, for example No Raid."
          }
        },
        "type": "object",
        "required": [
          "code",
          "name"
        ],
        "title": "DedicatedLayout"
      },
      "RentalPowerStatusResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/RentalPowerStatus"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "RentalPowerStatusResponse",
        "example": {
          "success": true,
          "data": {
            "rental_id": 201,
            "power_state": "On",
            "power_actions": [
              "start",
              "shutdown",
              "stop",
              "reset"
            ],
            "reinstall": true
          }
        }
      },
      "RentalPowerStatus": {
        "properties": {
          "rental_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Rental Id"
          },
          "power_state": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Power State"
          },
          "power_actions": {
            "items": {
              "type": "string",
              "enum": [
                "start",
                "shutdown",
                "stop",
                "reboot",
                "reset"
              ]
            },
            "type": "array",
            "title": "Power Actions"
          },
          "reinstall": {
            "type": "boolean",
            "title": "Reinstall"
          }
        },
        "type": "object",
        "required": [
          "rental_id",
          "power_state",
          "power_actions",
          "reinstall"
        ],
        "title": "RentalPowerStatus"
      },
      "RentalPowerBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id"
          },
          "action": {
            "type": "string",
            "enum": [
              "start",
              "shutdown",
              "reboot",
              "stop",
              "reset"
            ],
            "title": "Action"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "action"
        ],
        "title": "RentalPowerBody",
        "example": {
          "api_key_id": 1,
          "action": "start"
        }
      },
      "RentalOperationResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/RentalOperation"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "RentalOperationResponse",
        "example": {
          "success": true,
          "data": {
            "id": 301,
            "rental_id": 201,
            "action": "dedicated_power",
            "status": "succeeded",
            "created_at": "2026-10-04T12:00:00Z",
            "started_at": "2026-10-04T12:00:01Z",
            "finished_at": "2026-10-04T12:00:05Z",
            "result": {
              "power_state": "On",
              "changed": true,
              "power_action": "start"
            },
            "requires_review": false,
            "review_resolved_at": null,
            "error_code": null,
            "error_message": null
          }
        }
      },
      "RentalOperation": {
        "properties": {
          "id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Id"
          },
          "rental_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Rental Id"
          },
          "action": {
            "type": "string",
            "enum": [
              "dedicated_power",
              "dedicated_reinstall"
            ],
            "title": "Action"
          },
          "status": {
            "type": "string",
            "enum": [
              "queued",
              "running",
              "succeeded",
              "failed",
              "cancelled"
            ],
            "title": "Status"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "started_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Started At"
          },
          "finished_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Finished At"
          },
          "result": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/RentalPowerResult"
              },
              {
                "$ref": "#/components/schemas/RentalReinstallResult"
              },
              {
                "type": "null"
              }
            ],
            "title": "Result"
          },
          "requires_review": {
            "type": "boolean",
            "title": "Requires Review",
            "default": false
          },
          "review_resolved_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Review Resolved At"
          },
          "error_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Code"
          },
          "error_message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Message"
          }
        },
        "type": "object",
        "required": [
          "id",
          "rental_id",
          "action",
          "status",
          "created_at",
          "started_at",
          "finished_at"
        ],
        "title": "RentalOperation"
      },
      "RentalPowerResult": {
        "properties": {
          "power_state": {
            "type": "string",
            "title": "Power State"
          },
          "changed": {
            "type": "boolean",
            "title": "Changed"
          },
          "power_action": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "start",
                  "shutdown",
                  "reboot",
                  "stop",
                  "reset"
                ]
              },
              {
                "type": "null"
              }
            ],
            "title": "Power Action"
          }
        },
        "type": "object",
        "required": [
          "power_state",
          "changed"
        ],
        "title": "RentalPowerResult"
      },
      "RentalReinstallResult": {
        "properties": {
          "os": {
            "type": "string",
            "title": "Os"
          },
          "verified": {
            "type": "boolean",
            "const": true,
            "title": "Verified"
          }
        },
        "type": "object",
        "required": [
          "os",
          "verified"
        ],
        "title": "RentalReinstallResult"
      },
      "RentalReinstallBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id"
          },
          "os_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Os Id"
          },
          "confirmed": {
            "type": "boolean",
            "const": true,
            "title": "Confirmed"
          },
          "password": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 4096,
                "minLength": 1
              },
              {
                "type": "null"
              }
            ],
            "title": "Password"
          },
          "ssh_public_key": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 8192,
                "minLength": 1
              },
              {
                "type": "null"
              }
            ],
            "title": "Ssh Public Key"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "os_id",
          "confirmed"
        ],
        "title": "RentalReinstallBody",
        "example": {
          "api_key_id": 1,
          "os_id": 11,
          "confirmed": true
        }
      },
      "RentalOperationListResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/RentalOperation"
            },
            "type": "array",
            "title": "Data"
          },
          "total_count": {
            "type": "integer",
            "title": "Total Count"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data",
          "total_count"
        ],
        "title": "RentalOperationListResponse",
        "example": {
          "success": true,
          "data": [
            {
              "id": 301,
              "rental_id": 201,
              "action": "dedicated_power",
              "status": "queued",
              "created_at": "2026-10-04T12:00:00Z",
              "started_at": null,
              "finished_at": null,
              "result": null,
              "requires_review": false,
              "review_resolved_at": null,
              "error_code": null,
              "error_message": null
            }
          ],
          "total_count": 1
        }
      },
      "DedicatedPlanDisk": {
        "properties": {
          "count": {
            "minimum": 1,
            "title": "Count",
            "type": "integer"
          },
          "size_gb": {
            "minimum": 1,
            "title": "Size Gb",
            "type": "integer"
          },
          "type": {
            "title": "Type",
            "type": "string"
          },
          "model": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Model"
          },
          "id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Id",
            "description": "Opaque disk-group ID; null for a shared-layout plan."
          },
          "disk_layouts": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/DedicatedGroupLayout"
                },
                "type": "array"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Disk Layouts",
            "description": "Group options: display name and submit code."
          },
          "default_disk_layout": {
            "anyOf": [
              {
                "enum": [
                  "separate",
                  "lvm_linear",
                  "raid0",
                  "raid1",
                  "raid5",
                  "raid6",
                  "raid10"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Default Disk Layout"
          }
        },
        "required": [
          "count",
          "size_gb",
          "type"
        ],
        "title": "DedicatedPlanDisk",
        "type": "object"
      },
      "DedicatedGroupLayout": {
        "properties": {
          "code": {
            "enum": [
              "separate",
              "lvm_linear",
              "raid0",
              "raid1",
              "raid5",
              "raid6",
              "raid10"
            ],
            "title": "Code",
            "type": "string"
          },
          "name": {
            "title": "Name",
            "type": "string"
          }
        },
        "required": [
          "code",
          "name"
        ],
        "title": "DedicatedGroupLayout",
        "type": "object"
      },
      "LocationUptime": {
        "properties": {
          "location_id": {
            "type": "integer",
            "maximum": 9223372036854775807,
            "minimum": 1,
            "title": "Location Id",
            "description": "Location ID."
          },
          "location_name": {
            "type": "string",
            "title": "Location Name",
            "description": "Location name."
          },
          "uptime_percent": {
            "anyOf": [
              {
                "type": "number",
                "maximum": 100.0,
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Uptime Percent",
            "description": "Mean uptime of observed hosting nodes in the location, as a percentage; null without observations."
          },
          "coverage_percent": {
            "anyOf": [
              {
                "type": "number",
                "maximum": 100.0,
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Coverage Percent",
            "description": "Percentage of time covered by up/down observations. Missing data, maintenance and monitor errors are not counted as confirmed downtime."
          },
          "days": {
            "$ref": "#/components/schemas/UptimeDays",
            "description": "Period in days: 1, 14, 30 or 90."
          },
          "from": {
            "type": "string",
            "format": "date-time",
            "title": "From",
            "description": "Interval start in UTC, ISO 8601."
          },
          "to": {
            "type": "string",
            "format": "date-time",
            "title": "To",
            "description": "Interval end in UTC, ISO 8601."
          },
          "points": {
            "items": {
              "$ref": "#/components/schemas/UptimePoint"
            },
            "type": "array",
            "title": "Points",
            "description": "Hourly points for 1 day; daily UTC points for 14/30/90 days. Edge intervals are clipped to the rolling window."
          }
        },
        "type": "object",
        "required": [
          "location_id",
          "location_name",
          "uptime_percent",
          "coverage_percent",
          "days",
          "from",
          "to",
          "points"
        ],
        "title": "LocationUptime"
      },
      "LocationUptimeResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/LocationUptime"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "LocationUptimeResponse",
        "example": {
          "success": true,
          "data": {
            "location_id": 1,
            "location_name": "US — Fremont",
            "uptime_percent": 99.8,
            "coverage_percent": 100,
            "days": 1,
            "from": "2026-10-11T00:00:00Z",
            "to": "2026-10-12T00:00:00Z",
            "points": [
              {
                "from": "2026-10-11T00:00:00Z",
                "to": "2026-10-11T01:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T01:00:00Z",
                "to": "2026-10-11T02:00:00Z",
                "uptime_percent": 95.2,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T02:00:00Z",
                "to": "2026-10-11T03:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T03:00:00Z",
                "to": "2026-10-11T04:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T04:00:00Z",
                "to": "2026-10-11T05:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T05:00:00Z",
                "to": "2026-10-11T06:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T06:00:00Z",
                "to": "2026-10-11T07:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T07:00:00Z",
                "to": "2026-10-11T08:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T08:00:00Z",
                "to": "2026-10-11T09:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T09:00:00Z",
                "to": "2026-10-11T10:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T10:00:00Z",
                "to": "2026-10-11T11:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T11:00:00Z",
                "to": "2026-10-11T12:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T12:00:00Z",
                "to": "2026-10-11T13:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T13:00:00Z",
                "to": "2026-10-11T14:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T14:00:00Z",
                "to": "2026-10-11T15:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T15:00:00Z",
                "to": "2026-10-11T16:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T16:00:00Z",
                "to": "2026-10-11T17:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T17:00:00Z",
                "to": "2026-10-11T18:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T18:00:00Z",
                "to": "2026-10-11T19:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T19:00:00Z",
                "to": "2026-10-11T20:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T20:00:00Z",
                "to": "2026-10-11T21:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T21:00:00Z",
                "to": "2026-10-11T22:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T22:00:00Z",
                "to": "2026-10-11T23:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              },
              {
                "from": "2026-10-11T23:00:00Z",
                "to": "2026-10-12T00:00:00Z",
                "uptime_percent": 100,
                "coverage_percent": 100
              }
            ]
          }
        }
      },
      "LocationUptimeSummary": {
        "properties": {
          "location_id": {
            "type": "integer",
            "maximum": 9223372036854775807,
            "minimum": 1,
            "title": "Location Id",
            "description": "Location ID."
          },
          "location_name": {
            "type": "string",
            "title": "Location Name",
            "description": "Location name."
          },
          "uptime_percent": {
            "anyOf": [
              {
                "type": "number",
                "maximum": 100.0,
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Uptime Percent",
            "description": "Mean uptime of observed hosting nodes in the location, as a percentage; null without observations."
          },
          "coverage_percent": {
            "anyOf": [
              {
                "type": "number",
                "maximum": 100.0,
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Coverage Percent",
            "description": "Percentage of time covered by up/down observations. Missing data, maintenance and monitor errors are not counted as confirmed downtime."
          }
        },
        "type": "object",
        "required": [
          "location_id",
          "location_name",
          "uptime_percent",
          "coverage_percent"
        ],
        "title": "LocationUptimeSummary"
      },
      "LocationsUptime": {
        "properties": {
          "days": {
            "$ref": "#/components/schemas/UptimeDays",
            "description": "Period in days: 1, 14, 30 or 90."
          },
          "locations": {
            "items": {
              "$ref": "#/components/schemas/LocationUptimeSummary"
            },
            "type": "array",
            "title": "Locations"
          }
        },
        "type": "object",
        "required": [
          "days",
          "locations"
        ],
        "title": "LocationsUptime"
      },
      "LocationsUptimeResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/LocationsUptime"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "LocationsUptimeResponse",
        "example": {
          "success": true,
          "data": {
            "days": 1,
            "locations": [
              {
                "location_id": 1,
                "location_name": "US — Fremont",
                "uptime_percent": 99.8,
                "coverage_percent": 100
              },
              {
                "location_id": 3,
                "location_name": "PL — Gdańsk",
                "uptime_percent": null,
                "coverage_percent": 0
              }
            ]
          }
        }
      },
      "UptimeDays": {
        "type": "integer",
        "enum": [
          1,
          14,
          30,
          90
        ],
        "title": "UptimeDays"
      },
      "UptimePoint": {
        "properties": {
          "from": {
            "type": "string",
            "format": "date-time",
            "title": "From",
            "description": "Interval start in UTC, ISO 8601."
          },
          "to": {
            "type": "string",
            "format": "date-time",
            "title": "To",
            "description": "Interval end in UTC, ISO 8601."
          },
          "uptime_percent": {
            "anyOf": [
              {
                "type": "number",
                "maximum": 100.0,
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Uptime Percent",
            "description": "Mean uptime of observed hosting nodes in the location, as a percentage; null without observations."
          },
          "coverage_percent": {
            "anyOf": [
              {
                "type": "number",
                "maximum": 100.0,
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Coverage Percent",
            "description": "Percentage of time covered by up/down observations. Missing data, maintenance and monitor errors are not counted as confirmed downtime."
          }
        },
        "type": "object",
        "required": [
          "from",
          "to",
          "uptime_percent",
          "coverage_percent"
        ],
        "title": "UptimePoint"
      },
      "VmTrafficDay": {
        "properties": {
          "day": {
            "format": "date",
            "title": "Day",
            "type": "string",
            "description": "UTC date."
          },
          "incoming_bytes": {
            "minimum": 0,
            "title": "Incoming Bytes",
            "type": "integer",
            "description": "Incoming traffic for the day, in bytes."
          },
          "outgoing_bytes": {
            "minimum": 0,
            "title": "Outgoing Bytes",
            "type": "integer",
            "description": "Outgoing traffic for the day, in bytes."
          },
          "estimated": {
            "title": "Estimated",
            "type": "boolean",
            "description": "Usage was distributed across days in proportion to time."
          },
          "updated_at": {
            "format": "date-time",
            "title": "Updated At",
            "type": "string",
            "description": "Last update for the day, in UTC."
          }
        },
        "required": [
          "day",
          "incoming_bytes",
          "outgoing_bytes",
          "estimated",
          "updated_at"
        ],
        "title": "VmTrafficDay",
        "type": "object"
      },
      "VmTrafficHistory": {
        "properties": {
          "vm_id": {
            "title": "Vm Id",
            "type": "integer"
          },
          "days": {
            "items": {
              "$ref": "#/components/schemas/VmTrafficDay"
            },
            "title": "Days",
            "type": "array"
          }
        },
        "required": [
          "vm_id",
          "days"
        ],
        "title": "VmTrafficHistory",
        "type": "object"
      },
      "VmTrafficHistoryResponse": {
        "properties": {
          "success": {
            "title": "Success",
            "type": "boolean"
          },
          "data": {
            "$ref": "#/components/schemas/VmTrafficHistory"
          }
        },
        "required": [
          "success",
          "data"
        ],
        "title": "VmTrafficHistoryResponse",
        "type": "object",
        "example": {
          "success": true,
          "data": {
            "vm_id": 101,
            "days": [
              {
                "day": "2026-10-11",
                "incoming_bytes": 1048576,
                "outgoing_bytes": 2097152,
                "estimated": false,
                "updated_at": "2026-10-11T23:59:00Z"
              },
              {
                "day": "2026-10-12",
                "incoming_bytes": 524288,
                "outgoing_bytes": 1048576,
                "estimated": true,
                "updated_at": "2026-10-12T01:00:00Z"
              }
            ]
          }
        }
      },
      "OrderQueue": {
        "properties": {
          "location_id": {
            "title": "Location Id",
            "type": "integer"
          },
          "platform": {
            "enum": [
              "epyc",
              "ryzen",
              "xeon"
            ],
            "title": "Platform",
            "type": "string"
          },
          "waiting": {
            "minimum": 0,
            "title": "Waiting",
            "type": "integer",
            "description": "Total waiting count; cached up to 5 seconds."
          },
          "order_id": {
            "title": "Order Id",
            "type": "integer"
          },
          "operation_id": {
            "title": "Operation Id",
            "type": "integer"
          },
          "status": {
            "enum": [
              "queued",
              "running",
              "succeeded",
              "failed",
              "cancelled"
            ],
            "title": "Status",
            "type": "string",
            "description": "Provisioning operation status, not billing order status."
          },
          "position": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Position",
            "description": "Position among waiting orders, or null outside the queue; not a guaranteed delivery order."
          },
          "reason": {
            "anyOf": [
              {
                "enum": [
                  "node_busy",
                  "node_unavailable",
                  "ip_pool_exhausted",
                  "network_pool_empty"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reason"
          },
          "can_cancel": {
            "title": "Can Cancel",
            "type": "boolean",
            "description": "Whether cancellation is possible at the time of reading."
          },
          "created_at": {
            "format": "date-time",
            "title": "Created At",
            "type": "string",
            "description": "Operation creation time in UTC."
          }
        },
        "required": [
          "location_id",
          "platform",
          "waiting",
          "order_id",
          "operation_id",
          "status",
          "position",
          "reason",
          "can_cancel",
          "created_at"
        ],
        "title": "OrderQueue",
        "type": "object"
      },
      "OrderQueueResponse": {
        "properties": {
          "success": {
            "title": "Success",
            "type": "boolean"
          },
          "data": {
            "$ref": "#/components/schemas/OrderQueue"
          }
        },
        "required": [
          "success",
          "data"
        ],
        "title": "OrderQueueResponse",
        "type": "object",
        "example": {
          "success": true,
          "data": {
            "order_id": 42,
            "operation_id": 501,
            "status": "queued",
            "location_id": 3,
            "platform": "epyc",
            "waiting": 4,
            "position": 2,
            "reason": "node_unavailable",
            "can_cancel": true,
            "created_at": "2026-10-12T08:00:00Z"
          }
        }
      },
      "VmQueueCount": {
        "properties": {
          "location_id": {
            "title": "Location Id",
            "type": "integer"
          },
          "platform": {
            "enum": [
              "epyc",
              "ryzen",
              "xeon"
            ],
            "title": "Platform",
            "type": "string"
          },
          "waiting": {
            "minimum": 0,
            "title": "Waiting",
            "type": "integer",
            "description": "Total waiting count; cached up to 5 seconds."
          }
        },
        "required": [
          "location_id",
          "platform",
          "waiting"
        ],
        "title": "VmQueueCount",
        "type": "object"
      },
      "VmQueueCountResponse": {
        "properties": {
          "success": {
            "title": "Success",
            "type": "boolean"
          },
          "data": {
            "$ref": "#/components/schemas/VmQueueCount"
          }
        },
        "required": [
          "success",
          "data"
        ],
        "title": "VmQueueCountResponse",
        "type": "object",
        "example": {
          "success": true,
          "data": {
            "location_id": 3,
            "platform": "epyc",
            "waiting": 4
          }
        }
      },
      "ApplicationItem": {
        "properties": {
          "id": {
            "title": "Id",
            "type": "integer"
          },
          "app_code": {
            "title": "App Code",
            "type": "string"
          },
          "category": {
            "title": "Category",
            "type": "string"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "variant": {
            "title": "Variant",
            "type": "string"
          },
          "version": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Version"
          },
          "logo_url": {
            "title": "Logo Url",
            "type": "string"
          },
          "documentation_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Documentation Url"
          },
          "supported_os": {
            "items": {
              "type": "string"
            },
            "title": "Supported Os",
            "type": "array"
          },
          "recommended_os": {
            "title": "Recommended Os",
            "type": "string"
          },
          "min_cpu_cores": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Min Cpu Cores"
          },
          "min_ram_mb": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Min Ram Mb"
          },
          "min_disk_gb": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Min Disk Gb"
          },
          "recommended_cpu_cores": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Recommended Cpu Cores"
          },
          "recommended_ram_mb": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Recommended Ram Mb"
          },
          "recommended_disk_gb": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Recommended Disk Gb"
          },
          "requirements_source_urls": {
            "items": {
              "type": "string"
            },
            "title": "Requirements Source Urls",
            "type": "array"
          },
          "installation_mode": {
            "default": "cloud_init",
            "enum": [
              "cloud_init",
              "background"
            ],
            "title": "Installation Mode",
            "type": "string",
            "description": "cloud_init: installation during cloud-init; background: installation continues after VPS issue."
          },
          "installer_sha256": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Installer Sha256",
            "description": "Installer checksum in saved installation metadata; omitted from the catalog."
          }
        },
        "required": [
          "id",
          "app_code",
          "category",
          "name",
          "variant",
          "version",
          "logo_url",
          "documentation_url",
          "supported_os",
          "recommended_os",
          "min_cpu_cores",
          "min_ram_mb",
          "min_disk_gb",
          "recommended_cpu_cores",
          "recommended_ram_mb",
          "recommended_disk_gb",
          "requirements_source_urls"
        ],
        "title": "ApplicationItem",
        "type": "object",
        "description": "Application snapshot for this installation, or null when absent. Contains the public catalog metadata and installer_sha256, a checksum of the saved installer, never its contents or credentials. For an order, this is the purchase snapshot; VPS details/list reflect the latest successful installation.",
        "example": {
          "id": 1,
          "app_code": "wordpress",
          "category": "websites",
          "name": "WordPress",
          "variant": "",
          "version": null,
          "logo_url": "https://cdn.example.com/app/wordpress.svg",
          "documentation_url": null,
          "supported_os": [
            "ubuntu-24.04"
          ],
          "recommended_os": "ubuntu-24.04",
          "min_cpu_cores": 1,
          "min_ram_mb": 1024,
          "min_disk_gb": 20,
          "recommended_cpu_cores": 2,
          "recommended_ram_mb": 2048,
          "recommended_disk_gb": 40,
          "requirements_source_urls": [],
          "installation_mode": "cloud_init"
        }
      },
      "ApplicationsResponse": {
        "properties": {
          "success": {
            "default": true,
            "title": "Success",
            "type": "boolean"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/ApplicationItem"
            },
            "title": "Data",
            "type": "array"
          },
          "total": {
            "title": "Total",
            "type": "integer"
          }
        },
        "required": [
          "data",
          "total"
        ],
        "title": "ApplicationsResponse",
        "type": "object",
        "example": {
          "success": true,
          "data": [
            {
              "id": 1,
              "app_code": "wordpress",
              "category": "websites",
              "name": "WordPress",
              "variant": "",
              "version": null,
              "logo_url": "https://cdn.example.com/app/wordpress.svg",
              "documentation_url": null,
              "supported_os": [
                "ubuntu-24.04"
              ],
              "recommended_os": "ubuntu-24.04",
              "min_cpu_cores": 1,
              "min_ram_mb": 1024,
              "min_disk_gb": 20,
              "recommended_cpu_cores": 2,
              "recommended_ram_mb": 2048,
              "recommended_disk_gb": 40,
              "requirements_source_urls": [],
              "installation_mode": "cloud_init"
            }
          ],
          "total": 1
        }
      },
      "VmNodeUptime": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "exclusiveMinimum": 0.0,
            "title": "Vm Id"
          },
          "days": {
            "$ref": "#/components/schemas/UptimeDays"
          },
          "from": {
            "type": "string",
            "format": "date-time",
            "title": "From"
          },
          "to": {
            "type": "string",
            "format": "date-time",
            "title": "To"
          },
          "uptime_percent": {
            "anyOf": [
              {
                "type": "number",
                "maximum": 100.0,
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Uptime Percent"
          },
          "coverage_percent": {
            "anyOf": [
              {
                "type": "number",
                "maximum": 100.0,
                "minimum": 0.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Coverage Percent"
          },
          "points": {
            "items": {
              "$ref": "#/components/schemas/UptimePoint"
            },
            "type": "array",
            "title": "Points"
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "days",
          "from",
          "to",
          "uptime_percent",
          "coverage_percent",
          "points"
        ],
        "title": "VmNodeUptime"
      },
      "VmNodeUptimeResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/VmNodeUptime"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "VmNodeUptimeResponse"
      },
      "Backup": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "service_id": {
            "type": "integer",
            "title": "Service Id"
          },
          "kind": {
            "type": "string",
            "enum": [
              "automatic",
              "manual"
            ],
            "title": "Kind"
          },
          "source_vm_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Source Vm Id"
          },
          "status": {
            "type": "string",
            "title": "Status"
          },
          "logical_size_bytes": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Logical Size Bytes"
          },
          "stored_size_bytes": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Stored Size Bytes",
            "description": "Storage size in bytes: compressed unique backup blocks. This is the size used to calculate manual backup storage charges, not the download archive size."
          },
          "vm_config": {
            "$ref": "#/components/schemas/BackupConfiguration"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "completed_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "deleted_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Deleted At"
          }
        },
        "type": "object",
        "required": [
          "id",
          "service_id",
          "kind",
          "source_vm_id",
          "status",
          "logical_size_bytes",
          "stored_size_bytes",
          "vm_config",
          "created_at",
          "completed_at",
          "deleted_at"
        ],
        "title": "Backup"
      },
      "BackupAutoRenewBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id"
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "auto_renew"
        ],
        "title": "BackupAutoRenewBody"
      },
      "BackupConfiguration": {
        "properties": {
          "name": {
            "type": "string",
            "title": "Name"
          },
          "os": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Os"
          },
          "cpu_cores": {
            "type": "integer",
            "title": "Cpu Cores"
          },
          "ram_mb": {
            "type": "integer",
            "title": "Ram Mb"
          },
          "disks": {
            "items": {
              "$ref": "#/components/schemas/BackupDisk"
            },
            "type": "array",
            "title": "Disks"
          }
        },
        "type": "object",
        "required": [
          "name",
          "cpu_cores",
          "ram_mb",
          "disks"
        ],
        "title": "BackupConfiguration"
      },
      "BackupCreateBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id"
          },
          "vm_id": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Vm Id"
          },
          "kind": {
            "type": "string",
            "enum": [
              "automatic",
              "manual"
            ],
            "title": "Kind"
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "default": false
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{1,11}\\.\\d{4}$"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Confirmed amount. A changed price returns 409 price_changed."
          },
          "expected_manual_rate_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{1,11}\\.\\d{6}$"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Confirmed manual storage rate per GiB per month. A changed rate returns 409 price_changed."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "vm_id",
          "kind"
        ],
        "title": "BackupCreateBody"
      },
      "BackupDisk": {
        "properties": {
          "device": {
            "type": "string",
            "title": "Device"
          },
          "size_gb": {
            "type": "integer",
            "title": "Size Gb"
          },
          "purpose": {
            "type": "string",
            "title": "Purpose"
          }
        },
        "type": "object",
        "required": [
          "device",
          "size_gb",
          "purpose"
        ],
        "title": "BackupDisk"
      },
      "BackupEstimate": {
        "properties": {
          "vm_id": {
            "type": "integer",
            "title": "Vm Id"
          },
          "provisioned_size_bytes": {
            "type": "integer",
            "title": "Provisioned Size Bytes"
          },
          "guest_used_bytes": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Guest Used Bytes"
          },
          "stored_size_bytes": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Stored Size Bytes"
          },
          "exact_size_available_after_backup": {
            "type": "boolean",
            "const": true,
            "title": "Exact Size Available After Backup"
          }
        },
        "type": "object",
        "required": [
          "vm_id",
          "provisioned_size_bytes",
          "guest_used_bytes",
          "stored_size_bytes",
          "exact_size_available_after_backup"
        ],
        "title": "BackupEstimate"
      },
      "BackupEstimateResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/BackupEstimate"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "BackupEstimateResponse"
      },
      "BackupExport": {
        "properties": {
          "operation_id": {
            "type": "integer",
            "title": "Operation Id"
          },
          "backup_id": {
            "type": "integer",
            "title": "Backup Id"
          },
          "status": {
            "type": "string",
            "enum": [
              "queued",
              "running",
              "ready",
              "failed",
              "expired"
            ],
            "title": "Status"
          },
          "size_bytes": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Size Bytes",
            "description": "Download size in bytes: the separately generated ZIP archive. It may differ from stored_size_bytes because the disk image is reconstructed and compressed again for export."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "completed_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Completed At"
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expires At"
          },
          "download_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Download Url"
          },
          "download_expires_at": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Download Expires At"
          }
        },
        "type": "object",
        "required": [
          "operation_id",
          "backup_id",
          "status",
          "size_bytes",
          "created_at",
          "completed_at",
          "expires_at"
        ],
        "title": "BackupExport"
      },
      "BackupExportResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/BackupExport"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "BackupExportResponse"
      },
      "BackupOperation": {
        "properties": {
          "operation_id": {
            "type": "integer",
            "title": "Operation Id"
          },
          "backup_service_id": {
            "type": "integer",
            "title": "Backup Service Id"
          },
          "action": {
            "type": "string",
            "title": "Action"
          },
          "status": {
            "type": "string",
            "title": "Status"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "finished_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Finished At"
          },
          "result": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/BackupOperationResult"
              },
              {
                "type": "null"
              }
            ]
          },
          "error_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Code",
            "description": "Error code. vm_admin_blocked means an administrative block denied the action; contact support."
          },
          "error_message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error Message"
          }
        },
        "type": "object",
        "required": [
          "operation_id",
          "backup_service_id",
          "action",
          "status",
          "created_at",
          "finished_at",
          "result",
          "error_code",
          "error_message"
        ],
        "title": "BackupOperation"
      },
      "BackupOperationResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/BackupOperation"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "BackupOperationResponse"
      },
      "BackupOperationResult": {
        "properties": {
          "backup_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Backup Id"
          },
          "backup_service_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Backup Service Id"
          },
          "vm_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Vm Id"
          },
          "target_vm_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Target Vm Id"
          },
          "requires_review": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "title": "Requires Review"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until"
          },
          "stored_size_bytes": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Stored Size Bytes"
          },
          "logical_size_bytes": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Logical Size Bytes"
          }
        },
        "type": "object",
        "title": "BackupOperationResult"
      },
      "BackupResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/Backup"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "BackupResponse"
      },
      "BackupRestoreInput": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id"
          },
          "vm_id": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Vm Id"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "vm_id"
        ],
        "title": "BackupRestoreInput"
      },
      "BackupService": {
        "properties": {
          "id": {
            "type": "integer",
            "title": "Id"
          },
          "api_user_id": {
            "type": "string",
            "title": "Api User Id"
          },
          "kind": {
            "type": "string",
            "enum": [
              "automatic",
              "manual"
            ],
            "title": "Kind"
          },
          "service_type": {
            "type": "string",
            "title": "Service Type"
          },
          "source_vm_id": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Source Vm Id"
          },
          "status": {
            "type": "string",
            "title": "Status"
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew"
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Paid Until"
          },
          "delete_after": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Delete After"
          },
          "activated_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Activated At"
          },
          "next_backup_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Next Backup At"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "deleted_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Deleted At"
          }
        },
        "type": "object",
        "required": [
          "id",
          "api_user_id",
          "kind",
          "service_type",
          "source_vm_id",
          "status",
          "auto_renew",
          "paid_until",
          "delete_after",
          "activated_at",
          "next_backup_at",
          "created_at",
          "deleted_at"
        ],
        "title": "BackupService"
      },
      "BackupServiceResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "$ref": "#/components/schemas/BackupService"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "title": "BackupServiceResponse"
      },
      "BackupServicesResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/BackupService"
            },
            "type": "array",
            "title": "Data"
          },
          "total_count": {
            "type": "integer",
            "title": "Total Count"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data",
          "total_count"
        ],
        "title": "BackupServicesResponse"
      },
      "BackupsResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "title": "Success"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/Backup"
            },
            "type": "array",
            "title": "Data"
          },
          "total_count": {
            "type": "integer",
            "title": "Total Count"
          }
        },
        "type": "object",
        "required": [
          "success",
          "data",
          "total_count"
        ],
        "title": "BackupsResponse"
      },
      "BackupPaymentBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{1,11}\\.\\d{4}$"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Confirmed amount. A changed price returns 409 price_changed."
          },
          "expected_manual_rate_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{1,11}\\.\\d{6}$"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Confirmed manual storage rate per GiB per month. A changed rate returns 409 price_changed."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id"
        ],
        "title": "BackupPaymentBody",
        "example": {
          "api_key_id": 1
        }
      },
      "BackupQuoteResponse": {
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "object",
            "required": [
              "amount_usd",
              "balance_usd",
              "currency",
              "months",
              "kind",
              "manual_gb_month_price_usd",
              "exact_size_available_after_backup"
            ],
            "properties": {
              "amount_usd": {
                "type": "string"
              },
              "balance_usd": {
                "type": "string"
              },
              "currency": {
                "type": "string",
                "enum": [
                  "USD"
                ]
              },
              "months": {
                "type": "integer",
                "enum": [
                  1
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "automatic",
                  "manual"
                ]
              },
              "manual_gb_month_price_usd": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "exact_size_available_after_backup": {
                "type": "boolean"
              }
            }
          }
        }
      },
      "IpPurchaseRequest": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id"
          },
          "months": {
            "type": "integer",
            "enum": [
              1,
              3,
              6,
              12,
              24,
              36
            ],
            "title": "Months",
            "default": 1,
            "description": "Calendar months: 1, 3, 6, 12, 24 or 36; defaults to 1."
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^\\d{1,11}\\.\\d{4}$"
              },
              {
                "type": "null"
              }
            ],
            "title": "Expected Amount Usd"
          },
          "api_user_id": {
            "type": "string",
            "maxLength": 255,
            "minLength": 1,
            "pattern": "\\S",
            "title": "Api User Id",
            "description": "Partner customer ID that owns the address."
          },
          "location_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Location Id",
            "description": "Location ID from GET /plans."
          },
          "auto_renew": {
            "type": "boolean",
            "title": "Auto Renew",
            "default": false,
            "description": "Renew for the selected term at the current price; defaults to false."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "api_user_id",
          "location_id"
        ],
        "title": "IpPurchaseRequest"
      },
      "IpRenewBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id"
          },
          "months": {
            "anyOf": [
              {
                "type": "integer",
                "enum": [
                  1,
                  3,
                  6,
                  12,
                  24,
                  36
                ]
              },
              {
                "type": "null"
              }
            ],
            "title": "Months",
            "description": "Calendar months: 1, 3, 6, 12, 24 or 36. Omitted renewal months retains the last paid term."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id"
        ],
        "title": "IpRenewBody"
      },
      "IpPurchaseQuoteResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "object",
            "properties": {
              "amount_usd": {
                "type": "string",
                "example": "4.5000"
              },
              "balance_usd": {
                "type": "string",
                "example": "100.0000"
              },
              "currency": {
                "type": "string",
                "enum": [
                  "USD"
                ]
              },
              "location_id": {
                "type": "integer"
              },
              "months": {
                "type": "integer",
                "enum": [
                  1,
                  3,
                  6,
                  12,
                  24,
                  36
                ]
              },
              "monthly_price_usd": {
                "type": "string",
                "example": "1.5000"
              }
            },
            "required": [
              "amount_usd",
              "balance_usd",
              "currency",
              "location_id",
              "months",
              "monthly_price_usd"
            ]
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "AlertItem": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Alert ID"
          },
          "text_ru": {
            "type": "string",
            "description": "Russian text"
          },
          "text_en": {
            "type": "string",
            "description": "English text"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Creation date in UTC"
          },
          "starts_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "description": "Event start in UTC or null"
          },
          "ends_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "description": "Event end in UTC or null"
          },
          "locations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AlertLocation"
            },
            "description": "Locations associated with the alert, ordered by location_id. An empty array means no location link. The list is saved with the alert: locations added later are not included automatically. Display names and country codes are stored for this alert and remain unchanged when locations are renamed."
          }
        },
        "required": [
          "id",
          "text_ru",
          "text_en",
          "created_at",
          "starts_at",
          "ends_at",
          "locations"
        ],
        "title": "AlertItem"
      },
      "AlertsResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "alerts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AlertItem"
            }
          }
        },
        "required": [
          "success",
          "alerts"
        ],
        "title": "AlertsResponse",
        "example": {
          "success": true,
          "alerts": [
            {
              "id": 1,
              "text_ru": "🇵🇱 Польша: добавлены мощности VPS на AMD Ryzen 9 9950X3D.",
              "text_en": "🇵🇱 Poland: VPS capacity added on AMD Ryzen 9 9950X3D.",
              "created_at": "2026-10-18T10:00:00Z",
              "starts_at": null,
              "ends_at": null,
              "locations": [
                {
                  "location_id": 1,
                  "location_name": "Poland",
                  "country_code": "PL"
                }
              ]
            },
            {
              "id": 2,
              "text_ru": "Плановое обновление нод с перезагрузкой серверов.",
              "text_en": "Scheduled node maintenance with server restarts.",
              "created_at": "2026-10-18T09:00:00Z",
              "starts_at": "2026-10-19T02:00:00Z",
              "ends_at": "2026-10-19T03:00:00Z",
              "locations": [
                {
                  "location_id": 1,
                  "location_name": "Poland",
                  "country_code": "PL"
                },
                {
                  "location_id": 2,
                  "location_name": "Germany",
                  "country_code": "DE"
                }
              ]
            }
          ]
        }
      },
      "MailMailbox": {
        "type": "object",
        "required": [
          "id",
          "account_id",
          "domain_id",
          "email",
          "name",
          "status",
          "enabled",
          "access_allowed",
          "quota_mb",
          "file_quota_bytes",
          "ready_at",
          "paid_until",
          "delete_after",
          "api_user_id",
          "auto_renew",
          "outbound_high_limit",
          "outbound_daily_recipient_limit",
          "outbound_daily_recipients_used",
          "outbound_daily_recipients_remaining",
          "outbound_messages_per_minute",
          "outbound_minute_messages_used",
          "outbound_minute_messages_remaining",
          "outbound_recipients_per_message",
          "storage_shared",
          "used_bytes",
          "file_used_bytes"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 0
          },
          "account_id": {
            "type": "integer",
            "minimum": 0
          },
          "domain_id": {
            "type": "integer",
            "minimum": 0
          },
          "email": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "access_allowed": {
            "type": "boolean"
          },
          "quota_mb": {
            "type": "integer",
            "minimum": 0,
            "description": "Shared limit for messages, attachments and files in MiB."
          },
          "used_bytes": {
            "type": "integer",
            "minimum": 0,
            "description": "Total used storage in bytes, already including files and MIME encoding."
          },
          "file_quota_bytes": {
            "type": "integer",
            "minimum": 0,
            "description": "The same shared limit in bytes: quota_mb × 1048576. Not additional to quota_mb."
          },
          "file_used_bytes": {
            "type": "integer",
            "minimum": 0,
            "description": "Original size of separate files before MIME encoding, for analytics. Do not add to used_bytes."
          },
          "signature": {
            "type": "string"
          },
          "ready_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "delete_after": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "updated_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "api_user_id": {
            "type": "string"
          },
          "auto_renew": {
            "type": "boolean"
          },
          "outbound_high_limit": {
            "type": "boolean",
            "description": "Mailbox has an increased daily limit."
          },
          "outbound_daily_recipient_limit": {
            "type": "integer",
            "minimum": 0,
            "description": "Recipient limit for the last 24 hours."
          },
          "outbound_daily_recipients_used": {
            "type": "integer",
            "minimum": 0,
            "description": "Recipients counted in the last 24 hours."
          },
          "outbound_daily_recipients_remaining": {
            "type": "integer",
            "minimum": 0,
            "description": "Remaining recipients for the 24-hour window, at least 0."
          },
          "outbound_messages_per_minute": {
            "type": "integer",
            "minimum": 0,
            "description": "Message limit for the last 60 seconds."
          },
          "outbound_minute_messages_used": {
            "type": "integer",
            "minimum": 0,
            "description": "Messages counted in the last 60 seconds."
          },
          "outbound_minute_messages_remaining": {
            "type": "integer",
            "minimum": 0,
            "description": "Remaining messages for the 60-second window, at least 0."
          },
          "outbound_recipients_per_message": {
            "type": "integer",
            "minimum": 0,
            "description": "Maximum recipients per message across To/Cc/Bcc."
          },
          "storage_shared": {
            "type": "boolean",
            "enum": [
              true
            ],
            "description": "Messages, attachments and files share one storage quota."
          }
        }
      },
      "MailOperation": {
        "type": "object",
        "required": [
          "id",
          "kind",
          "mailbox_id",
          "status",
          "run_at",
          "created_at",
          "completed_at",
          "error",
          "result"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "kind": {
            "type": "string"
          },
          "mailbox_id": {
            "type": "integer",
            "minimum": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "queued",
              "running",
              "succeeded",
              "failed",
              "uncertain",
              "cancelled"
            ]
          },
          "run_at": {
            "type": "string",
            "format": "date-time"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "completed_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "error": {
            "anyOf": [
              {
                "type": "string",
                "description": "mail_daily_limit_exceeded: Recipient limit for the last 24 hours reached.\nmail_minute_limit_exceeded: Message limit for the last 60 seconds reached.\nmail_too_many_recipients: Too many recipients in one message.\nmail_policy_unavailable: Sending limit checking is temporarily unavailable.\nmailbox_unavailable: Sending from the mailbox is unavailable.\nmail_operation_failed: Other mail operation failure."
              },
              {
                "type": "null"
              }
            ]
          },
          "result": {
            "type": "object",
            "properties": {
              "mailbox_id": {
                "type": "integer",
                "minimum": 1
              },
              "email": {
                "type": "string"
              },
              "quota_mb": {
                "type": "integer",
                "minimum": 1
              },
              "status": {
                "type": "string"
              },
              "ready_at": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date-time"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "paid_until": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date-time"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": []
          }
        }
      },
      "MailMailboxResponse": {
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailMailbox"
          }
        }
      },
      "MailMailboxesResponse": {
        "type": "object",
        "required": [
          "success",
          "data",
          "total_count"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MailMailbox"
            }
          },
          "total_count": {
            "type": "integer",
            "minimum": 0
          }
        }
      },
      "MailOperationResponse": {
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailOperation"
          }
        }
      },
      "MailRequest": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          }
        },
        "required": [
          "api_key_id"
        ],
        "title": "MailRequest",
        "type": "object"
      },
      "MailAccountCreate": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "api_user_id": {
            "maxLength": 255,
            "minLength": 1,
            "title": "Api User Id",
            "type": "string",
            "description": "Your stable customer identifier within this integration."
          },
          "name": {
            "maxLength": 120,
            "minLength": 1,
            "title": "Name",
            "type": "string",
            "description": "Display name."
          }
        },
        "required": [
          "api_key_id",
          "api_user_id",
          "name"
        ],
        "title": "AccountCreate",
        "type": "object"
      },
      "MailAccountUpdate": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "name": {
            "anyOf": [
              {
                "maxLength": 120,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Name",
            "description": "Display name."
          },
          "enabled": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Enabled",
            "description": "Whether access is enabled."
          },
          "password": {
            "anyOf": [
              {
                "maxLength": 128,
                "minLength": 12,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Password",
            "description": "New password, 12–128 characters."
          }
        },
        "required": [
          "api_key_id"
        ],
        "title": "AccountUpdate",
        "type": "object"
      },
      "MailDomainCreate": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "name": {
            "maxLength": 253,
            "minLength": 3,
            "title": "Name",
            "type": "string",
            "description": "Full domain name without a scheme, path or port."
          }
        },
        "required": [
          "api_key_id",
          "name"
        ],
        "title": "DomainCreate",
        "type": "object"
      },
      "MailPayment": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "pattern": "^\\d{1,11}\\.\\d{4}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Expected Amount Usd",
            "description": "Optional price confirmation, a USD string with four decimal places. Purchase/renewal requires an exact match; for upgrade this is the maximum accepted amount. A higher/changed price returns 409 price_changed without payment."
          }
        },
        "required": [
          "api_key_id"
        ],
        "title": "MailPayment",
        "type": "object"
      },
      "MailPurchase": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "pattern": "^\\d{1,11}\\.\\d{4}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Expected Amount Usd",
            "description": "Optional price confirmation, a USD string with four decimal places. Purchase/renewal requires an exact match; for upgrade this is the maximum accepted amount. A higher/changed price returns 409 price_changed without payment."
          },
          "account_id": {
            "exclusiveMinimum": 0,
            "title": "Account Id",
            "type": "integer",
            "description": "Customer account ID in this integration."
          },
          "domain_id": {
            "exclusiveMinimum": 0,
            "title": "Domain Id",
            "type": "integer",
            "description": "ID of an active domain available to the account."
          },
          "local_part": {
            "pattern": "^[a-z0-9][a-z0-9._-]{0,63}$",
            "title": "Local Part",
            "type": "string",
            "description": "Address before @, lowercase Latin letters, digits, dots, underscores and hyphens; first character must be a letter or digit."
          },
          "name": {
            "maxLength": 120,
            "minLength": 1,
            "title": "Name",
            "type": "string",
            "description": "Display name."
          },
          "password": {
            "maxLength": 128,
            "minLength": 12,
            "title": "Password",
            "type": "string",
            "description": "New password, 12–128 characters."
          },
          "plan_code": {
            "maxLength": 64,
            "minLength": 1,
            "title": "Plan Code",
            "type": "string",
            "description": "Active code from GET /mail/plans."
          },
          "auto_renew": {
            "default": false,
            "title": "Auto Renew",
            "type": "boolean",
            "description": "Renew automatically from the integration balance."
          }
        },
        "required": [
          "api_key_id",
          "account_id",
          "domain_id",
          "local_part",
          "name",
          "password",
          "plan_code"
        ],
        "title": "MailPurchase",
        "type": "object"
      },
      "MailUpgrade": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "expected_amount_usd": {
            "anyOf": [
              {
                "pattern": "^\\d{1,11}\\.\\d{4}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Expected Amount Usd",
            "description": "Optional price confirmation, a USD string with four decimal places. Purchase/renewal requires an exact match; for upgrade this is the maximum accepted amount. A higher/changed price returns 409 price_changed without payment."
          },
          "plan_code": {
            "maxLength": 64,
            "minLength": 1,
            "title": "Plan Code",
            "type": "string",
            "description": "Active code from GET /mail/plans."
          }
        },
        "required": [
          "api_key_id",
          "plan_code"
        ],
        "title": "MailUpgrade",
        "type": "object"
      },
      "MailboxSettings": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "name": {
            "anyOf": [
              {
                "maxLength": 120,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Name",
            "description": "Display name."
          },
          "password": {
            "anyOf": [
              {
                "maxLength": 128,
                "minLength": 12,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Password",
            "description": "New password, 12–128 characters."
          },
          "signature": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "title": "Signature",
            "description": "Mailbox signature; an empty string clears it."
          }
        },
        "required": [
          "api_key_id"
        ],
        "title": "MailboxSettings",
        "type": "object"
      },
      "MailAutoRenew": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "auto_renew": {
            "title": "Auto Renew",
            "type": "boolean",
            "description": "Renew automatically from the integration balance."
          }
        },
        "required": [
          "api_key_id",
          "auto_renew"
        ],
        "title": "MailAutoRenew",
        "type": "object"
      },
      "MailAccess": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "enabled": {
            "title": "Enabled",
            "type": "boolean",
            "description": "Whether access is enabled."
          }
        },
        "required": [
          "api_key_id",
          "enabled"
        ],
        "title": "MailAccess",
        "type": "object"
      },
      "MailAssign": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "account_id": {
            "exclusiveMinimum": 0,
            "title": "Account Id",
            "type": "integer",
            "description": "Customer account ID in this integration."
          }
        },
        "required": [
          "api_key_id",
          "account_id"
        ],
        "title": "MailAssign",
        "type": "object"
      },
      "MailKeyCreate": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "name": {
            "maxLength": 120,
            "minLength": 1,
            "title": "Name",
            "type": "string",
            "description": "Display name."
          }
        },
        "required": [
          "api_key_id",
          "name"
        ],
        "title": "MailKeyCreate",
        "type": "object"
      },
      "MailAccount": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 1
          },
          "api_user_id": {
            "type": "string"
          },
          "login": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "api_user_id",
          "login",
          "name",
          "enabled",
          "created_at",
          "updated_at"
        ]
      },
      "MailAccountSecret": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 1
          },
          "api_user_id": {
            "type": "string"
          },
          "login": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "password": {
            "type": "string",
            "description": "Present after initial creation and password reset; absent on repeated creation."
          }
        },
        "required": [
          "id",
          "api_user_id",
          "login",
          "name",
          "enabled",
          "created_at",
          "updated_at"
        ]
      },
      "MailPlan": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "mail_quota_mb": {
            "type": "integer",
            "minimum": 1,
            "description": "Shared capacity for mail and files in MiB."
          },
          "file_quota_mb": {
            "type": "integer",
            "minimum": 0,
            "description": "The same shared limit in MiB, equal to mail_quota_mb. Do not add the two fields."
          },
          "monthly_price_usd": {
            "type": "string",
            "description": "Final USD price for one calendar month."
          },
          "active": {
            "type": "boolean"
          },
          "storage_shared": {
            "type": "boolean",
            "enum": [
              true
            ],
            "description": "Messages, attachments and files share one storage quota."
          }
        },
        "required": [
          "code",
          "mail_quota_mb",
          "file_quota_mb",
          "monthly_price_usd",
          "active",
          "storage_shared"
        ]
      },
      "MailPlans": {
        "type": "object",
        "properties": {
          "currency": {
            "type": "string",
            "enum": [
              "USD"
            ]
          },
          "period": {
            "type": "string",
            "enum": [
              "calendar_month"
            ]
          },
          "upgrade_only": {
            "type": "boolean"
          },
          "max_mail_quota_mb": {
            "type": "integer",
            "minimum": 1
          },
          "storage_step_mb": {
            "type": "integer",
            "minimum": 1
          },
          "plans": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MailPlan"
            }
          }
        },
        "required": [
          "currency",
          "period",
          "upgrade_only",
          "max_mail_quota_mb",
          "storage_step_mb",
          "plans"
        ]
      },
      "MailDomain": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 1
          },
          "name": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "deleting",
              "deleted"
            ]
          },
          "is_shared": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "name",
          "status",
          "is_shared"
        ]
      },
      "MailIntegrationDomain": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 1
          },
          "name": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "deleting",
              "deleted"
            ]
          },
          "is_shared": {
            "type": "boolean"
          },
          "account_id": {
            "type": "integer",
            "minimum": 1
          },
          "api_user_id": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "status",
          "is_shared",
          "account_id",
          "api_user_id"
        ]
      },
      "MailDnsRecord": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "observed": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "matches": {
            "type": "boolean"
          },
          "error": {
            "type": "string",
            "enum": [
              "dns_unavailable"
            ]
          }
        },
        "required": [
          "type",
          "name",
          "value",
          "observed",
          "matches"
        ]
      },
      "MailDns": {
        "type": "object",
        "properties": {
          "domain_id": {
            "type": "integer",
            "minimum": 1
          },
          "status": {
            "type": "string"
          },
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MailDnsRecord"
            }
          }
        },
        "required": [
          "domain_id",
          "status",
          "records"
        ]
      },
      "MailQuote": {
        "type": "object",
        "properties": {
          "amount_usd": {
            "type": "string"
          },
          "balance_usd": {
            "type": "string"
          },
          "currency": {
            "type": "string",
            "enum": [
              "USD"
            ]
          },
          "months": {
            "type": "integer",
            "enum": [
              1
            ]
          },
          "plan": {
            "$ref": "#/components/schemas/MailPlan"
          },
          "allow_negative_balance": {
            "type": "boolean"
          }
        },
        "required": [
          "amount_usd",
          "balance_usd",
          "currency",
          "months",
          "plan",
          "allow_negative_balance"
        ]
      },
      "MailKey": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 1
          },
          "name": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "active": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "name",
          "prefix",
          "created_at",
          "active"
        ]
      },
      "MailKeyCreated": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 1
          },
          "name": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "key": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "prefix",
          "created_at",
          "key"
        ]
      },
      "MailKeyDetails": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 1
          },
          "name": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "active": {
            "type": "boolean"
          },
          "key": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "prefix",
          "created_at",
          "active",
          "key"
        ]
      },
      "MailMailboxState": {
        "type": "object",
        "required": [
          "id",
          "account_id",
          "domain_id",
          "email",
          "name",
          "status",
          "enabled",
          "access_allowed",
          "quota_mb",
          "file_quota_bytes",
          "ready_at",
          "paid_until",
          "delete_after",
          "api_user_id",
          "auto_renew",
          "outbound_high_limit",
          "outbound_daily_recipient_limit",
          "outbound_messages_per_minute",
          "outbound_recipients_per_message",
          "storage_shared",
          "used_bytes",
          "file_used_bytes"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 0
          },
          "account_id": {
            "type": "integer",
            "minimum": 0
          },
          "domain_id": {
            "type": "integer",
            "minimum": 0
          },
          "email": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "access_allowed": {
            "type": "boolean"
          },
          "quota_mb": {
            "type": "integer",
            "minimum": 0,
            "description": "Shared limit for messages, attachments and files in MiB."
          },
          "used_bytes": {
            "type": "integer",
            "minimum": 0,
            "description": "Total used storage in bytes, already including files and MIME encoding."
          },
          "file_quota_bytes": {
            "type": "integer",
            "minimum": 0,
            "description": "The same shared limit in bytes: quota_mb × 1048576. Not additional to quota_mb."
          },
          "file_used_bytes": {
            "type": "integer",
            "minimum": 0,
            "description": "Original size of separate files before MIME encoding, for analytics. Do not add to used_bytes."
          },
          "signature": {
            "type": "string"
          },
          "ready_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "paid_until": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "delete_after": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "updated_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "api_user_id": {
            "type": "string"
          },
          "auto_renew": {
            "type": "boolean"
          },
          "outbound_high_limit": {
            "type": "boolean",
            "description": "Mailbox has an increased daily limit."
          },
          "outbound_daily_recipient_limit": {
            "type": "integer",
            "minimum": 0,
            "description": "Recipient limit for the last 24 hours."
          },
          "outbound_messages_per_minute": {
            "type": "integer",
            "minimum": 0,
            "description": "Message limit for the last 60 seconds."
          },
          "outbound_recipients_per_message": {
            "type": "integer",
            "minimum": 0,
            "description": "Maximum recipients per message across To/Cc/Bcc."
          },
          "storage_shared": {
            "type": "boolean",
            "enum": [
              true
            ],
            "description": "Messages, attachments and files share one storage quota."
          }
        }
      },
      "MailAccountResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailAccount"
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailAccountSecretResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailAccountSecret"
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailAccountsResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MailAccount"
            }
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailPlansResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailPlans"
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailDomainsResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MailIntegrationDomain"
            }
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailAccountDomainsResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MailDomain"
            }
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailDomainResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailDomain"
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailDnsResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailDns"
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailQuoteResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailQuote"
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailDeletedResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "deleted": {
                "type": "boolean",
                "enum": [
                  true
                ]
              }
            },
            "required": [
              "deleted"
            ]
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailKeysResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MailKey"
            }
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailKeyCreatedResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailKeyCreated"
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailKeyDetailsResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailKeyDetails"
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailKeyRemovalResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "revoked": {
                    "type": "boolean",
                    "enum": [
                      true
                    ]
                  }
                },
                "required": [
                  "revoked"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "deleted": {
                    "type": "boolean",
                    "enum": [
                      true
                    ]
                  }
                },
                "required": [
                  "deleted"
                ]
              }
            ]
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailMailboxStateResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailMailboxState"
          }
        },
        "required": [
          "success",
          "data"
        ]
      },
      "MailLoginLinkRequest": {
        "additionalProperties": false,
        "properties": {
          "api_key_id": {
            "exclusiveMinimum": 0,
            "maximum": 9223372036854775807,
            "title": "Api Key Id",
            "type": "integer",
            "description": "Integration ID matching X-Api-Key."
          },
          "mailbox_id": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 1,
                "maximum": 9223372036854775807
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Mailbox ID in this account; null opens the whole account."
          },
          "locale": {
            "type": "string",
            "enum": [
              "en",
              "ru",
              "fr",
              "es",
              "de",
              "zh-cn",
              "ko",
              "tr",
              "hi",
              "pt-br"
            ],
            "default": "en"
          }
        },
        "required": [
          "api_key_id"
        ],
        "title": "MailLoginLinkRequest",
        "type": "object",
        "example": {
          "api_key_id": 1,
          "mailbox_id": 42,
          "locale": "en"
        }
      },
      "MailLoginLink": {
        "type": "object",
        "required": [
          "login_url",
          "expires_in",
          "expires_at",
          "account_id",
          "mailbox_id"
        ],
        "properties": {
          "login_url": {
            "type": "string",
            "format": "uri",
            "description": "One-time link; preserve the #token fragment when opening."
          },
          "expires_in": {
            "type": "integer",
            "enum": [
              300
            ]
          },
          "expires_at": {
            "type": "string",
            "format": "date-time"
          },
          "account_id": {
            "type": "integer",
            "minimum": 1
          },
          "mailbox_id": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 1
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "MailLoginLinkResponse": {
        "type": "object",
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/MailLoginLink"
          }
        },
        "example": {
          "success": true,
          "data": {
            "login_url": "https://adapt-mail.com/auth/#token=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
            "expires_in": 300,
            "expires_at": "2026-10-21T12:05:00Z",
            "account_id": 12,
            "mailbox_id": 42
          }
        }
      },
      "FirewallSmtpBody": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Numeric integration ID from the dashboard; must match X-Api-Key."
          },
          "revision": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 0.0,
            "title": "Revision",
            "description": "Current firewall revision from GET firewall. Reread on conflict."
          },
          "blocked": {
            "type": "boolean",
            "title": "Blocked",
            "description": "true blocks outbound SMTP ports; false opens them."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "revision",
          "blocked"
        ],
        "title": "FirewallSmtpBody",
        "example": {
          "api_key_id": 1,
          "revision": 0,
          "blocked": false
        }
      },
      "AlertLocation": {
        "type": "object",
        "properties": {
          "location_id": {
            "type": "integer",
            "description": "Linked location ID."
          },
          "location_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Stored display name, such as Poland; may differ from the location catalog. null when unspecified."
          },
          "country_code": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^[A-Z]{2}$"
              },
              {
                "type": "null"
              }
            ],
            "description": "Two-letter country code for the flag, such as PL. null when unspecified."
          }
        },
        "required": [
          "location_id",
          "location_name",
          "country_code"
        ],
        "title": "AlertLocation"
      },
      "LookingGlassCheckRequest": {
        "properties": {
          "api_key_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Api Key Id",
            "description": "Integration ID matching X-Api-Key."
          },
          "point_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Point Id",
            "description": "Point ID from GET /looking-glass/points."
          },
          "type": {
            "type": "string",
            "enum": [
              "ping",
              "traceroute",
              "mtr"
            ],
            "title": "Type",
            "description": "Manual diagnostic: ping, traceroute or mtr."
          },
          "family": {
            "type": "integer",
            "enum": [
              4,
              6
            ],
            "title": "Family",
            "description": "IP family: integer 4 or 6; a numeric target must match the selected family."
          },
          "target": {
            "type": "string",
            "maxLength": 253,
            "minLength": 1,
            "title": "Target",
            "description": "Public numeric IP or domain without protocol, port, path or query. DNS is resolved in the selected location."
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "api_key_id",
          "point_id",
          "type",
          "family",
          "target"
        ],
        "title": "CheckRequest"
      },
      "LookingGlassCheckResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "const": true,
            "title": "Success",
            "default": true
          },
          "data": {
            "$ref": "#/components/schemas/LookingGlassCheckResult"
          }
        },
        "type": "object",
        "required": [
          "data"
        ],
        "title": "CheckResponse"
      },
      "LookingGlassCheckResult": {
        "properties": {
          "point_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Point Id"
          },
          "type": {
            "type": "string",
            "enum": [
              "ping",
              "traceroute",
              "mtr"
            ],
            "title": "Type"
          },
          "target": {
            "type": "string",
            "title": "Target",
            "description": "Actual tested IP after DNS resolution."
          },
          "family": {
            "type": "integer",
            "enum": [
              4,
              6
            ],
            "title": "Family"
          },
          "return_code": {
            "anyOf": [
              {
                "type": "integer",
                "maximum": 255.0,
                "minimum": -255.0
              },
              {
                "type": "null"
              }
            ],
            "title": "Return Code",
            "description": "Command exit code; a nonzero value is not an HTTP error. Null when timed_out=true."
          },
          "timed_out": {
            "type": "boolean",
            "title": "Timed Out",
            "description": "When true, the check returned an incomplete result and return_code=null. The HTTP status remains 200."
          },
          "duration_ms": {
            "type": "integer",
            "maximum": 40000.0,
            "minimum": 0.0,
            "title": "Duration Ms",
            "description": "Diagnostic execution time in milliseconds, not network latency."
          },
          "output": {
            "type": "string",
            "maxLength": 65536,
            "title": "Output",
            "description": "Ping/Traceroute text or an MTR JSON string. Render as text; fall back to raw text if MTR JSON parsing fails."
          }
        },
        "type": "object",
        "required": [
          "point_id",
          "type",
          "target",
          "family",
          "return_code",
          "timed_out",
          "duration_ms",
          "output"
        ],
        "title": "CheckResult"
      },
      "LookingGlassPointsResponse": {
        "properties": {
          "success": {
            "type": "boolean",
            "const": true,
            "title": "Success",
            "default": true
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/LookingGlassPoint"
            },
            "type": "array",
            "title": "Data"
          }
        },
        "type": "object",
        "required": [
          "data"
        ],
        "title": "PointsResponse"
      },
      "LookingGlassPoint": {
        "properties": {
          "id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Id"
          },
          "location_id": {
            "type": "integer",
            "maximum": 9.223372036854776e+18,
            "minimum": 1.0,
            "title": "Location Id"
          },
          "location_name": {
            "type": "string",
            "title": "Location Name"
          },
          "country_code": {
            "type": "string",
            "title": "Country Code"
          },
          "city": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "City"
          },
          "ipv4": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ipv4"
          },
          "ipv6": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Ipv6"
          },
          "ipv4_enabled": {
            "type": "boolean",
            "title": "Ipv4 Enabled",
            "description": "Whether diagnostics are enabled for this family; the presence of an IP alone does not imply availability."
          },
          "ipv6_enabled": {
            "type": "boolean",
            "title": "Ipv6 Enabled",
            "description": "Whether diagnostics are enabled for this family; the presence of an IP alone does not imply availability."
          },
          "latency_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Latency Url",
            "description": "HTTPS URL for direct browser latency measurements; null when the relevant family is disabled or no hostname is configured. Returned unchanged. With both families enabled, the browser selects the family; with only one enabled, its URL is used."
          },
          "latency_ipv4_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Latency Ipv4 Url",
            "description": "HTTPS URL for direct browser latency measurements; null when the relevant family is disabled or no hostname is configured. Returned unchanged."
          },
          "latency_ipv6_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Latency Ipv6 Url",
            "description": "HTTPS URL for direct browser latency measurements; null when the relevant family is disabled or no hostname is configured. Returned unchanged."
          },
          "checks": {
            "items": {
              "type": "string",
              "enum": [
                "ping",
                "traceroute",
                "mtr"
              ]
            },
            "type": "array",
            "title": "Checks"
          }
        },
        "type": "object",
        "required": [
          "id",
          "location_id",
          "location_name",
          "country_code",
          "city",
          "ipv4",
          "ipv6",
          "ipv4_enabled",
          "ipv6_enabled",
          "latency_url",
          "latency_ipv4_url",
          "latency_ipv6_url",
          "checks"
        ],
        "title": "LookingGlassPoint"
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Api-Key",
        "description": "Secret integration key from the dashboard. IP access is configured in the dashboard under **IP allowlist**. An empty list permits requests from any IP; otherwise the client must match an allowed IPv4/IPv6 address or CIDR subnet. A valid API key is always required. Requests outside the list return HTTP 403 with `detail.code=ip_not_allowed`. Dashboard access and outbound webhooks are unaffected."
      }
    }
  },
  "servers": [
    {
      "url": "https://cloud-api.adaptgroup.pro"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Catalog",
      "x-displayName": "Catalog",
      "description": "Catalog endpoints for your Cloud API integration."
    },
    {
      "name": "Monitoring",
      "x-displayName": "Monitoring",
      "description": "Location uptime for your Cloud API integration."
    },
    {
      "name": "VPS billing",
      "x-displayName": "VPS billing",
      "description": "VPS billing endpoints for your Cloud API integration."
    },
    {
      "name": "VPS management",
      "x-displayName": "VPS management",
      "description": "VPS management endpoints for your Cloud API integration."
    },
    {
      "name": "Firewall",
      "x-displayName": "Firewall",
      "description": "Firewall endpoints for your Cloud API integration."
    },
    {
      "name": "IP addresses",
      "x-displayName": "IP addresses",
      "description": "IP addresses endpoints for your Cloud API integration."
    },
    {
      "name": "Dedicated servers",
      "x-displayName": "Dedicated servers",
      "description": "Dedicated servers endpoints for your Cloud API integration."
    },
    {
      "name": "Orders",
      "x-displayName": "Orders",
      "description": "Orders endpoints for your Cloud API integration."
    },
    {
      "name": "Balance",
      "x-displayName": "Balance",
      "description": "Balance endpoints for your Cloud API integration."
    },
    {
      "name": "Backups",
      "x-displayName": "Backups",
      "description": "VPS backup storage and restoration.\n\n## Backup sizes\n\nBackup storage size (stored_size_bytes) and ZIP download size (export size_bytes) are different measurements. The export is built separately from the reconstructed disk image and compressed again, so its size may be larger or smaller. A size difference alone does not indicate a damaged backup."
    },
    {
      "name": "Mail",
      "description": "Accounts, domains, DNS, mailbox billing, settings, sending limits and API keys. Start with the [mail setup guide](./mail-guide)."
    },
    {
      "name": "Looking Glass",
      "x-displayName": "Looking Glass",
      "description": "Diagnostic points, manual checks and browser HTTPS latency."
    }
  ]
}
