{ "openapi": "3.0.2", "info": { "title": "Cloudzy Developer API Documentation", "description": "\n---\n## Overview\n\nThe **Cloudzy Developer API** is designed to facilitate the management of cloud resources, specifically virtual private servers (VPS). This RESTful API allows developers to programmatically create, manage, and delete instances, as well as perform operations related to operating systems, products, regions, and applications. \n\n### API Version\n\n- **Version**: v1\n\n### Base URL\n\n- **Base URL**: `/developers`\n\nThis base URL should be used as the prefix for all API endpoints.\n\n## Authentication\n\n### Authentication Method\n\nAll API requests require authentication through a token. Each user can obtain a unique **Developer API Token** that must be included in the `API-Token` header of every request to verify the identity of the user. \n\n### Obtaining Your Developer API Token\n\nTo obtain your Developer API Token, follow these steps:\n\n1. **Register for an Account**: If you haven't already, sign up for an account on the Cloudzy platform.\n2. **Generate Your Token**: Once registered, log in to your account and navigate to the API settings section. Here, you will find an option to generate your Developer API Token.\n3. **Copy Your Token**: After generating the token, make sure to copy it and store it securely. \n\n### Important Notes\n\n- **One Token Per User**: Each user can only have one Developer API Token at a time. If you need to regenerate your token, the previous one will be invalidated.\n- **Usage Restriction**: This token is specifically designed for use with the Cloudzy Developer APIs. It cannot be used for other services or APIs outside of the developer scope.\n- **Confidentiality**: Keep your token confidential. Do not share it with anyone or expose it in public repositories or client-side code, as it grants access to your account's API functionalities.\n\n\n## API Response Schema\n\nAll API responses from the Cloudzy Developer API follow a standardized structure to ensure consistency and clarity. Each response will include the following fields:\n\n### Response Fields\n\n- **detail**: \n - A human-readable description of the response. This field provides context about the result of the API call, making it easier for users to understand the outcome.\n\n- **code**: \n - A string representing the status of the API call. The possible values are:\n - **OKAY**: Indicates a successful operation.\n - **FAILED**: Indicates that the operation encountered an error or failure.\n\n- **data**: \n - This field contains additional information related to the response. It can be either:\n - A list or dictionary providing more details about the success or failure of the operation.\n - It may include specific error messages, validation errors, or relevant data returned by the API.\n\n### Success and Failure Responses\n\n- For successful API calls:\n - The `code` will be set to **OKAY**.\n - The `data` field will contain relevant information regarding the successful operation.\n\n- For failed API calls:\n - The `code` will be set to **FAILED**.\n - The `data` field will provide details about the cause of the failure, including any error messages or validation issues that occurred during the process.\n\n### Example Responses\n\n#### Successful Response Example\n\n```json\n{\n \"detail\": \"The operation completed successfully.\",\n \"code\": \"OKAY\",\n \"data\": {\n \"instanceId\": \"instance-12345\",\n \"status\": \"running\"\n }\n}\n\n```\n\n#### Failed Response Example\n```json\n{\n \"detail\": \"The requested instance was not found.\",\n \"code\": \"FAILED\",\n \"data\": {\n \"error\": \"InstanceNotFound\",\n \"statusCode\": 404\n }\n}\n```\n\n\n## Error Handling\n\nThe API provides standardized error responses for various failure scenarios. Common HTTP status codes include:\n\n| Status Code | Description |\n|-------------|--------------------------------------------------|\n| **2xx** | Success |\n| **400** | Bad Request (e.g., invalid parameters) |\n| **401** | Not Authorized (e.g., invalid or missing token)|\n| **404** | Not Found (e.g., resource does not exist) |\n| **422** | Validation Error (e.g., invalid input data) |\n| **4xx** | Custom Errors |\n\n---\n### Support\n\nFor additional support, please reach out to our customer service team via email at support@cloudzy.com or through our official support portal.\n\n---\n\n\n\n\n\n", "contact": { "name": "Cloudzy Support", "url": "https://cloudzy.com/contact-us/", "email": "support@cloudzy.com" }, "version": "0.1.0" }, "paths": { "/v1/instances": { "get": { "tags": [ "Instances" ], "summary": "List Instances", "description": "This API endpoint allows developers to retrieve a list of Virtual Private Server (VPS) instances.\n The results can be filtered based on various parameters such as creation time,\n hostname, status, region, and more. Pagination is supported using the `bookmark` parameter,\n which allows you to fetch subsequent pages of results.", "operationId": "list_instances_v1_instances_get", "parameters": [ { "description": "The UTC start time for creation range in ISO-8601 format.", "required": false, "schema": { "title": "Createdfrom", "type": "string", "description": "The UTC start time for creation range in ISO-8601 format." }, "example": "2022-08-20T08:03:03.690658Z", "name": "createdFrom", "in": "query" }, { "description": "The UTC end time for creation range in ISO-8601 format.", "required": false, "schema": { "title": "Createdto", "type": "string", "description": "The UTC end time for creation range in ISO-8601 format." }, "example": "2022-10-20T08:03:03.690658Z", "name": "createdTo", "in": "query" }, { "description": "The physical server that hosts the instances.", "required": false, "schema": { "title": "Host", "type": "string", "description": "The physical server that hosts the instances." }, "example": "uk02@192.168.5.1", "name": "host", "in": "query" }, { "description": "Filter result base on instance hostname.", "required": false, "schema": { "title": "Hostname", "type": "string", "description": "Filter result base on instance hostname." }, "name": "hostName", "in": "query" }, { "description": "Filter result base on instance status.", "required": false, "schema": { "title": "Status", "type": "string", "description": "Filter result base on instance status." }, "example": "shutdown", "name": "status", "in": "query" }, { "description": "Filter result base on instance region.", "required": false, "schema": { "title": "Region", "type": "string", "description": "Filter result base on instance region." }, "name": "region", "in": "query" }, { "description": "Filter result base on instance isoId.", "required": false, "schema": { "title": "Isoid", "type": "string", "description": "Filter result base on instance isoId." }, "name": "isoId", "in": "query" }, { "description": "Filter result base on instance os family.", "required": false, "schema": { "title": "Osfamily", "type": "string", "description": "Filter result base on instance os family." }, "name": "osFamily", "in": "query" }, { "description": "Filter result base on instance user ID.", "required": false, "schema": { "title": "Userid", "type": "string", "description": "Filter result base on instance user ID." }, "example": "36aa66df-a2e8-46cf-9175-71b39c6d3326", "name": "userId", "in": "query" }, { "description": "Filter result base on instance main IPv4.", "required": false, "schema": { "title": "Ipv4", "type": "string", "description": "Filter result base on instance main IPv4." }, "example": "178.20.10.30", "name": "ipv4", "in": "query" }, { "description": "Filter result base on instance main IPv6.", "required": false, "schema": { "title": "Ipv6", "type": "string", "description": "Filter result base on instance main IPv6." }, "name": "ipv6", "in": "query" }, { "description": "Bookmark for the requested page.", "required": false, "schema": { "title": "Bookmark", "type": "string", "description": "Bookmark for the requested page." }, "name": "bookmark", "in": "query" }, { "description": "Limit for instance page size.", "required": false, "schema": { "title": "Limit", "maximum": 100.0, "minimum": 5.0, "type": "integer", "description": "Limit for instance page size.", "default": 10 }, "name": "limit", "in": "query" }, { "required": false, "schema": { "title": "Includedeleted", "type": "boolean", "default": false }, "name": "includeDeleted", "in": "query" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInstanceResponseSchema" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Instances" ], "summary": "Create Instances", "description": "### Introduction\nThis API endpoint allows developers to create a new Virtual Private Server (VPS) instance.\n The VPS is a virtualized server that provides dedicated resources such as CPU, memory, storage, and networking capabilities, enabling users to deploy applications, host websites, or run custom workloads in an isolated environment.\n\n> **Important:** All request payload fields use camelCase or, in the case of the instance class, the literal key `class`. Field names shown below reflect the exact JSON keys the API expects.\n\n### **Request Body Parameters**\n\n| Parameter | Type | Required | Description | Example |\n| :--- | :--- | :--- | :--- | :--- |\n| `hostnames` | `List[str]` | **Yes** | A list of hostnames for the new instances. Must comply with Linux hostname conventions. | `[\"my-vps-1\", \"web-server\"]` |\n| `region` | `str` | **Yes** | The ID of the region where the instance will be deployed. | `\"region-123\"` |\n| `productId` | `str` | No | The ID of the fixed plan (product) to use. Required for fixed plan creation. | `\"product-456\"` |\n| `class` | `str` | No | The class of the instance. Options: `default`, `cpu-optimized`, `gpu-provided`. Default is `default`. | `\"cpu-optimized\"` |\n| `extraResource` | `object` | No | Additional resources (CPU, RAM, Disk, Bandwidth). See `ExtraResourceDetailSchema`. | `{\"diskInGB\": 50}` |\n| `osId` | `str` | No | The ID of the operating system to install. Required if not using ISO or Snapshot. | `\"ubuntu-22.04\"` |\n| `appId` | `str` | No | The ID of the One-Click Application (OCA) to install. | `\"wordpress\"` |\n| `isoId` | `str` | No | The ID of the custom ISO to mount. | `\"iso-789\"` |\n| `osName` | `str` | No | A custom name for the OS when using an ISO. | `\"Custom Linux\"` |\n| `sshKeyIds` | `List[int]` | No | A list of SSH Key IDs to inject into the instance. | `[101, 102]` |\n| `assignIpv4` | `bool` | No | Whether to assign a public IPv4 address. Default is `false`. | `true` |\n| `assignIpv6` | `bool` | No | Whether to assign a public IPv6 address. Default is `false`. | `true` |\n| `floatingIPCount` | `int` | No | Number of floating IPs to allocate (0-5). Default is `0`. | `1` |\n| `isDdosProtected` | `bool` | No | Whether to enable DDoS protection. | `true` |\n| `billingCycle` | `str` | No | Billing cycle. Options: `hourly`, `monthly`, etc. Default is `hourly`. | `\"monthly\"` |\n| `isSubscriptionAutoRenewEnabled` | `bool` | No | Whether to auto-renew the subscription. Default is `true`. | `false` |\n| `featureIds` | `List[str]` | No | List of additional features to enable. | `[\"monitoring\"]` |\n| `fromSnapshot` | `str` | No | The ID of a snapshot to restore from. | `\"snap-321\"` |\n| `customerId` | `str` | No | (Admin only) The ID of the customer to create the instance for. | `\"cust-001\"` |\n\n### **ExtraResourceDetailSchema**\n\n| Field | Type | Description |\n| :--- | :--- | :--- |\n| `cpu` | `int` | Number of vCPUs. |\n| `ramInGB` | `int` | RAM in GB. |\n| `diskInGB` | `int` | Disk size in GB. |\n| `bandwidthInTB` | `int` | Bandwidth in TB. |\n\n---\n\n### **Create an Instance with Fixed Plans**\n\nTo create an instance using a fixed plan, you need to specify the `productId` parameter in the request. The `productId` corresponds to a predefined plan that includes specific resource allocations (e.g., CPU, RAM, storage).\n\n**Additional Flexibility for Fixed Plans:**\nYou can also add extra disk space and bandwidth to a fixed plan by using the `extraResource` object. However, note that **extra CPU and extra RAM** are only available for instances created with custom configurations.\n\n**Fetching Product IDs:**\nThe `productId` must be fetched from the `/products` endpoint. Each product belongs to specific regions, which can be fetched from the `/regions` endpoint. Ensure that the `region` parameter matches the region ID of the selected product.\n\n**Example Request:**\n```json\n{\n \"hostnames\": [\"my-instance\"],\n \"productId\": \"fixed-plan-123\",\n \"region\": \"region-456\",\n \"class\": \"default\",\n \"extraResource\": {\n \"diskInGB\": 50,\n \"bandwidthInTB\": 2\n },\n \"assignIpv4\": true\n}\n```\n\n---\n\n### **Create an Instance with Custom Configs**\n\nTo create an instance with custom configurations, use the `extraResource` object to define the desired resources such as CPU, RAM, disk size, and bandwidth. Ensure that the `productId` is not provided when using custom configurations.\n\n**Mandatory Fields for Custom Instances:**\n- **`class`:** This parameter is mandatory for custom instances and determines the type of VM:\n - `default`: Regular VPS with balanced resources.\n - `cpu-optimized`: Optimized for CPU-intensive workloads.\n - `gpu-provided`: Includes GPU resources for specialized tasks like machine learning or rendering.\n - **Note:** Extra charges may apply depending on the selected `class`.\n\n- **`region`:** The region parameter is mandatory for custom instances and must match the region ID where the instance will be deployed.\n\n**Example Request:**\n```json\n{\n \"hostnames\": [\"custom-instance\"],\n \"region\": \"region-456\",\n \"class\": \"cpu-optimized\",\n \"extraResource\": {\n \"cpu\": 4,\n \"ramInGB\": 8,\n \"diskInGB\": 100,\n \"bandwidthInTB\": 5\n },\n \"osId\": \"ubuntu-22.04\",\n \"assignIpv4\": true\n}\n```\n\n---\n\n### **Create Multiple Instances at Once**\n\nTo create multiple instances in a single API call, provide a list of hostnames in the `hostnames` parameter. Each hostname will correspond to a separate instance.\n\n**Hostname Validation:**\nHostnames must comply with valid Linux hostname naming conventions. If the hostname is invalid, a validation error will be raised.\n\n**Example Request:**\n```json\n{\n \"hostnames\": [\"instance-1\", \"instance-2\", \"instance-3\"],\n \"productId\": \"fixed-plan-123\",\n \"region\": \"region-456\",\n \"class\": \"default\",\n \"assignIpv4\": true\n}\n```\n\n---\n\n### **Create an ISO-Based Instance**\n\nTo create an instance using a custom ISO file, specify the `isoId` parameter. The ISO file must be uploaded via the panel, and its ID should be used in this field. Additionally, you must provide the `osName` field, which will be used as the name for the ISO. Any random name is acceptable.\n\n**Example Request:**\n```json\n{\n \"hostnames\": [\"iso-instance\"],\n \"isoId\": \"iso-12345\",\n \"osName\": \"Custom-ISO-Name\",\n \"region\": \"region-456\",\n \"class\": \"default\",\n \"assignIpv4\": true\n}\n```\n\n---\n\n### **Create an OCA-Based Instance**\n\nTo create an instance pre-configured with a one-click application (OCA), specify the `appId` parameter. Additionally, you must also pass the `osId` parameter to select the operating system on which the application will be installed. For example, WordPress can be installed on Ubuntu 20.04 or 22.04, and the user must select between them.\n\n**Example Request:**\n```json\n{\n \"hostnames\": [\"oca-instance\"],\n \"appId\": \"wordpress\",\n \"osId\": \"ubuntu-22.04\",\n \"region\": \"region-456\",\n \"class\": \"default\",\n \"assignIpv4\": true\n}\n```\n\n---\n\n### **Assign IPv4 or IPv6 to an Instance**\n\nTo assign an IPv4 or IPv6 address to the instance, set the `assignIpv4` or `assignIpv6` parameters to `true`. **At least one of these parameters (`assignIpv4` or `assignIpv6`) must be enabled** for the instance to have network connectivity.\n\n**Example Request:**\n```json\n{\n \"hostnames\": [\"network-instance\"],\n \"productId\": \"fixed-plan-123\",\n \"region\": \"region-456\",\n \"class\": \"default\",\n \"assignIpv4\": true,\n \"assignIpv6\": false\n}\n```\n\n---\n\n### **Create Floating IPs Alongside a VM**\n\nTo create floating IPs alongside the VM, specify the `floatingIPCount` parameter. The value indicates the number of floating IPs to allocate. These IPs must be manually configured in the VM according to the provided documentation.\n\n**Example Request:**\n```json\n{\n \"hostnames\": [\"floating-ip-instance\"],\n \"productId\": \"fixed-plan-123\",\n \"region\": \"region-456\",\n \"class\": \"default\",\n \"floatingIPCount\": 2,\n \"assignIpv4\": true\n}\n```\n\n---\n\n### **Add SSH Keys to instance**\n\nSSH keys can be added to the instance for secure access. However, SSH keys must first be added via the panel, and their IDs must be used in the `sshKeyIds` parameter.\n\n**Example Request:**\n```json\n{\n \"hostnames\": [\"ssh-instance\"],\n \"productId\": \"fixed-plan-123\",\n \"region\": \"region-456\",\n \"class\": \"default\",\n \"sshKeyIds\": [123, 456],\n \"assignIpv4\": true\n}\n```\n\n---\n\n### **Summary Table**\n\n| **Requirement** | **Parameter(s)** |\n|-------------------------------------|----------------------------------------------------------------------------------|\n| Create with fixed plans | `productId`, `extraResource` (for additional disk/bandwidth) |\n| Create with custom configs | `extraResource`, `class`, `region` |\n| Create multiple instances at once | Provide multiple hostnames in the `hostnames` list |\n| Hostname Validation | Hostnames must comply with Linux hostname naming conventions |\n| Create ISO-based instance | `isoId`, `osName` |\n| Create OCA-based instance | `appId`, `osId` |\n| Assign IPv4 or IPv6 | At least one of `assignIpv4` or `assignIpv6` must be enabled |\n| Create floating IPs alongside VM | `floatingIPCount` |\n| Add SSH keys | SSH keys must be added via the panel; use their IDs in `sshKeyIds` |\n\n---", "operationId": "create_instances_v1_instances_post", "parameters": [ { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInstanceRequestSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInstanceResponseSchema" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "460": { "description": "Low Balance error", "content": { "application/json": { "example": { "detail": "You don't have enough balance for the selected product.", "code": "BALANCE_IS_NOT_SUFFICIENT", "data": { "minimumRequiredBalance": 203.09, "customerBalance": "353.00", "numberOfDaysBalanceValidatedAgainst": 5, "activeInstanceCount": 8 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/instances/{instanceId}/resize": { "post": { "tags": [ "Instances" ], "summary": "Resize Instance", "description": "### **Resize Instance**\n\n#### **Description**\nThis API endpoint allows developers to resize an existing Virtual Private Server (VPS) instance. Resizing can be performed in two modes: **Fixed Plan** or **Custom Configuration**, as specified by the `type` parameter.\n\n- **Fixed Plan Resize:** Allows you to switch the instance to a predefined plan (`productId`) with optional additional resources like extra disk space and bandwidth.\n- **Custom Configuration Resize:** Allows you to define custom resource allocations (CPU, RAM, disk, bandwidth) and requires specifying the `regionId`.\n\n\n\n\n\n#### **Request Body**\n\nBelow is the structure of the request:\n\n```json\n{\n \"type\": \"FIXED\",\n \"productId\": \"fixed-plan-123\",\n \"extraResource\": {\n \"diskInGB\": 50,\n \"bandwidthInTB\": 2\n }\n}\n```\n\n**Fields:**\n- **`type`** (`string`, required):\n Specifies the type of resize operation.\n - **Options**:\n - `FIXED`: Resize using a predefined config (`productId`).\n - `CUSTOM`: Resize using custom resource configurations.\n\n- **`productId`** (`string`, optional):\n Required for `FIXED` resize type. The ID of the predefined config(product) to which the instance will be resized.\n\n- **`regionId`** (`string`, optional):\n Required for `CUSTOM` resize type. The ID of the region where the instance resides.\n\n- **`extraResource`** (`object`, optional):\n Additional resources to allocate during resizing.\n - For `FIXED` resize: Optional extra disk space (`diskInGB`) and bandwidth (`bandwidthInTB`).\n - For `CUSTOM` resize: Required fields include `cpu`, `ramInGB`, `diskInGB`, and `bandwidthInTB`.\n\n**Structure of `extraResource`:**\n```json\n{\n \"cpu\": 4,\n \"ramInGB\": 8,\n \"diskInGB\": 100,\n \"bandwidthInTB\": 5\n}\n```\n---", "operationId": "resize_instance_v1_instances__instanceId__resize_post", "parameters": [ { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResizeInstanceRequestSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResizeInstanceResponseSchema" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "460": { "description": "Low Balance error", "content": { "application/json": { "example": { "detail": "You don't have enough balance for the selected product.", "code": "BALANCE_IS_NOT_SUFFICIENT", "data": { "minimumRequiredBalance": 203.09, "customerBalance": "353.00", "numberOfDaysBalanceValidatedAgainst": 5, "activeInstanceCount": 8 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/instances/{instanceId}/change-os": { "post": { "tags": [ "Instances" ], "summary": "Change Os", "description": "This API endpoint allows developers to change the operating system of an existing Virtual Private Server (VPS) instance.\n The new operating system is specified using the osId parameter, which corresponds to an available operating system id in the `/developers/v1/os/ endpoint.", "operationId": "change_os_v1_instances__instanceId__change_os_post", "parameters": [ { "required": true, "schema": { "title": "Instanceid", "type": "string" }, "name": "instanceId", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_change_os_v1_instances__instanceId__change_os_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeOsResponseSchema" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/instances/{instanceId}": { "get": { "tags": [ "Instances" ], "summary": "Get Instance Detail", "description": "Retrieve detailed information about a specific instance using its unique identifier (instanceId).", "operationId": "get_instance_detail_v1_instances__instanceId__get", "parameters": [ { "required": true, "schema": { "title": "Instanceid", "type": "string" }, "name": "instanceId", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInstanceResponseSchema" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Instances" ], "summary": "Delete Instance", "description": "Delete a specific instance permanently. This action cannot be undone.", "operationId": "delete_instance_v1_instances__instanceId__delete", "parameters": [ { "required": true, "schema": { "title": "Instanceid", "type": "string" }, "name": "instanceId", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "example": { "detail": "instance deleted successfully.", "code": "OKAY", "data": {} } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/instances/{instanceId}/subscription-refund": { "get": { "tags": [ "Instances" ], "summary": "Get Subscription Refund Detail", "description": "Retrieve detailed information about a specific instance using its unique identifier (instanceId).", "operationId": "get_subscription_refund_detail_v1_instances__instanceId__subscription_refund_get", "parameters": [ { "required": true, "schema": { "title": "Instanceid", "type": "string" }, "name": "instanceId", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionRefundDetailResponseSchema" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/instances/{instanceId}/poweroff": { "post": { "tags": [ "Instances" ], "summary": "Power Off Instance", "description": "Send a request to power off a specific instance. This operation gracefully shuts down the instance.", "operationId": "power_off_instance_v1_instances__instanceId__poweroff_post", "parameters": [ { "required": true, "schema": { "title": "Instanceid", "type": "string" }, "name": "instanceId", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "example": { "detail": "Sent power off request successfully.", "code": "OKAY", "data": {} } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/instances/{instanceId}/poweron": { "post": { "tags": [ "Instances" ], "summary": "Power On Instance", "description": "Send a request to power on a specific instance.", "operationId": "power_on_instance_v1_instances__instanceId__poweron_post", "parameters": [ { "required": true, "schema": { "title": "Instanceid", "type": "string" }, "name": "instanceId", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "example": { "detail": "Sent power on request successfully.", "code": "OKAY", "data": {} } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/instances/{instanceId}/add-traffic": { "post": { "tags": [ "Instances" ], "summary": "Delete Instance", "description": "Delete a specific instance permanently. This action cannot be undone.", "operationId": "delete_instance_v1_instances__instanceId__add_traffic_post", "parameters": [ { "required": true, "schema": { "title": "Instanceid", "type": "string" }, "name": "instanceId", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "example": { "detail": "Traffic added successfully." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/instances/{instanceId}/change-pass": { "post": { "tags": [ "Instances" ], "summary": "Change Instance Password", "description": "Changes instance password, Returns the new password in body.", "operationId": "change_instance_password_v1_instances__instanceId__change_pass_post", "parameters": [ { "required": true, "schema": { "title": "Instanceid", "type": "string" }, "name": "instanceId", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "example": { "detail": "Operation was successful.", "code": "OKAY", "data": { "password": "theGeneratedPassword" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/instances/{instanceId}/reset": { "post": { "tags": [ "Instances" ], "summary": "Reset Instance", "description": "Reset a specific instance. This operation reboots the instance and restores it to its initial state.", "operationId": "reset_instance_v1_instances__instanceId__reset_post", "parameters": [ { "required": true, "schema": { "title": "Instanceid", "type": "string" }, "name": "instanceId", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "example": { "detail": "instance was reset successfully.", "code": "OKAY", "data": {} } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/instances/bulk-subscription-refund": { "post": { "tags": [ "Instances" ], "summary": "Get Bulk Subscription Refund", "description": "Retrieve subscription refund details for multiple instances using their unique identifiers.", "operationId": "get_bulk_subscription_refund_v1_instances_bulk_subscription_refund_post", "parameters": [ { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSubscriptionRefundRequestSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSubscriptionRefundResponseSchema" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Instance Not Found", "code": "FAILED", "data": { "statusCode": 403, "detail": "Instance Not Found" } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/regions": { "get": { "tags": [ "Regions" ], "summary": "List Regions", "description": "This API endpoint provides a comprehensive list of all available regions where Virtual Private Server (VPS) instances\n can be deployed. Each region includes detailed information about its capabilities, configurations, and availability.\n This data helps developers and users make informed decisions when selecting a region for deploying their instances.\n\nThe response includes metadata such as the region's name, abbreviation, and image, as well as advanced configuration\n details like supported features (e.g., IPv6, GPU, custom plans) and resource thresholds (e.g., RAM, disk, IP limits).\n Additionally, the endpoint provides information about the region's status, including whether it is active, out of\n stock, or premium.", "operationId": "list_regions_v1_regions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Region Not Found.", "code": "FAILED", "data": { "statusCode": 404 } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized.", "code": "FAILED", "data": { "statusCode": 401 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } } } } }, "/v1/products": { "get": { "tags": [ "Products" ], "summary": "List Product", "description": "This API endpoint provides a comprehensive list of available products (plans) for Virtual Private Server (VPS) instances\n within a specified region. Each product includes detailed information about its specifications,\n pricing, and associated features such as operating systems, addons, and applications.\n This data helps developers and users make informed decisions when selecting a plan for deploying their instances.\nThe response includes metadata such as the product's ID, region, plan type, GPU details (if applicable),\n and resource allocations (e.g., CPU, RAM, storage, bandwidth). Additionally, the endpoint provides pricing details\n , including hourly and monthly rates with and without discounts, as well as the discount percentage.", "operationId": "list_product_v1_products_get", "parameters": [ { "required": true, "schema": { "title": "Regionid", "type": "string" }, "name": "regionId", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponseSchema" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Product Not Found.", "code": "FAILED", "data": { "statusCode": 404 } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized.", "code": "FAILED", "data": { "statusCode": 401 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/os": { "get": { "tags": [ "Operating Systems" ], "summary": "List Operating Systems", "description": "This API endpoint provides a comprehensive list of available operating systems that can be installed on Virtual Private Server (VPS) instances.\n Each operating system is accompanied by relevant details such as its name, version.", "operationId": "list_operating_systems_v1_os_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OsResponseSchema" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "OS Not Found.", "code": "FAILED", "data": { "statusCode": 404 } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized.", "code": "FAILED", "data": { "statusCode": 401 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } } } } }, "/v1/applications": { "get": { "tags": [ "Applications" ], "summary": "List Applications", "description": "Explore a diverse range of applications to meet your specific needs. From financial tools to content management systems,\n find the right solution for your requirements. This API endpoint provides a list of available applications categorized by their functionality and operating system compatibility.\n\nEach application is accompanied by a description highlighting its features and purpose, making it easier for developers\n and users to choose the appropriate tool for their projects.", "operationId": "list_applications_v1_applications_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListApplicationResponseSchema" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "detail": "Application Not Found.", "code": "FAILED", "data": { "statusCode": 404 } } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized.", "code": "FAILED", "data": { "statusCode": 401 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "detail": "Bad Request", "code": "FAILED", "data": { "statusCode": 400 } } } } } } } }, "/v1/ssh-keys": { "get": { "tags": [ "SSH Keys" ], "summary": "List Ssh Keys", "description": "Retrieve a list of SSH keys for the authenticated customer.", "operationId": "list_ssh_keys_v1_ssh_keys_get", "parameters": [ { "required": false, "schema": { "title": "Customerid", "type": "string" }, "name": "customerId", "in": "query" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSSHKeysResponseSchema" } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "SSH Keys" ], "summary": "Create New Ssh Key", "description": "Create a new SSH key for the authenticated developer customer.\n\nUse this endpoint to store SSH public keys for your account to later use in instance creation or direct ssh access.\n\nExample request (JSON):\n{\n \"name\": \"My Key\",\n \"publicKey\": \"ssh-rsa AAAAB3...\",\n \"customerId\": \"\"\n}", "operationId": "create_new_ssh_key_v1_ssh_keys_post", "parameters": [ { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKeyWriteSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/ssh-keys/{id}": { "get": { "tags": [ "SSH Keys" ], "summary": "Get Ssh Key", "description": "Get a single SSH key details by ID.", "operationId": "get_ssh_key_v1_ssh_keys__id__get", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "integer" }, "name": "id", "in": "path" }, { "required": false, "schema": { "title": "Customerid", "type": "string" }, "name": "customerId", "in": "query" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKeyReadSchema" } } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "SSH Keys" ], "summary": "Delete Ssh Key", "description": "Delete an SSH key by ID.", "operationId": "delete_ssh_key_v1_ssh_keys__id__delete", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "integer" }, "name": "id", "in": "path" }, { "required": false, "schema": { "title": "Customerid", "type": "string" }, "name": "customerId", "in": "query" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Not Authorized", "content": { "application/json": { "example": { "detail": "Not Authorized", "code": "FAILED", "data": { "statusCode": 403, "detail": "Not Authorized" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/floating-ips": { "get": { "tags": [ "Floating IPs" ], "summary": "List Floating Ips", "operationId": "list_floating_ips_v1_floating_ips_get", "parameters": [ { "required": false, "schema": { "title": "Address", "type": "string" }, "name": "address", "in": "query" }, { "required": false, "schema": { "title": "Region Id", "type": "string" }, "name": "region_id", "in": "query" }, { "required": false, "schema": { "title": "Expires After", "type": "number" }, "name": "expires_after", "in": "query" }, { "required": false, "schema": { "title": "Include Deleted", "type": "boolean", "default": false }, "name": "include_deleted", "in": "query" }, { "required": false, "schema": { "title": "Page", "type": "integer", "default": 1 }, "name": "page", "in": "query" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFloatingIpResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Floating IPs" ], "summary": "Add Floating Ip", "operationId": "add_floating_ip_v1_floating_ips_post", "parameters": [ { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddFloatingIPRequestSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddFloatingIpResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/floating-ips/{id}": { "patch": { "tags": [ "Floating IPs" ], "summary": "Update Floating Ip", "operationId": "update_floating_ip_v1_floating_ips__id__patch", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string" }, "name": "id", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFloatingIPRequestSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/floating-ips/{id}/release": { "post": { "tags": [ "Floating IPs" ], "summary": "Release Floating Ip", "operationId": "release_floating_ip_v1_floating_ips__id__release_post", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string" }, "name": "id", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/iso": { "get": { "tags": [ "Custom ISO" ], "summary": "List Iso", "operationId": "list_iso_v1_iso_get", "parameters": [ { "required": false, "schema": { "$ref": "#/components/schemas/IsoStatusEnum" }, "name": "status", "in": "query" }, { "required": false, "schema": { "title": "Limit", "type": "integer" }, "name": "limit", "in": "query" }, { "required": false, "schema": { "title": "Page", "type": "integer", "default": 1 }, "name": "page", "in": "query" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListIsoResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Custom ISO" ], "summary": "Download Iso", "operationId": "download_iso_v1_iso_post", "parameters": [ { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadIsoRequestSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadIsoResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/iso/{id}": { "get": { "tags": [ "Custom ISO" ], "summary": "Get Iso Detail", "operationId": "get_iso_detail_v1_iso__id__get", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string" }, "name": "id", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIsoDetailResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Custom ISO" ], "summary": "Delete Iso", "operationId": "delete_iso_v1_iso__id__delete", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string" }, "name": "id", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/images": { "get": { "tags": [ "Custom Image" ], "summary": "List Images", "operationId": "list_images_v1_images_get", "parameters": [ { "required": false, "schema": { "$ref": "#/components/schemas/ImageStatusEnum" }, "name": "status", "in": "query" }, { "required": false, "schema": { "title": "Limit", "type": "integer" }, "name": "limit", "in": "query" }, { "required": false, "schema": { "title": "Page", "type": "integer", "default": 1 }, "name": "page", "in": "query" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListImageResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Custom Image" ], "summary": "Download Image", "operationId": "download_image_v1_images_post", "parameters": [ { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadImageRequestSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadImageResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/images/{id}": { "get": { "tags": [ "Custom Image" ], "summary": "Get Image Detail", "operationId": "get_image_detail_v1_images__id__get", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string" }, "name": "id", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetImageDetailResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Custom Image" ], "summary": "Delete Image", "operationId": "delete_image_v1_images__id__delete", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string" }, "name": "id", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/snapshots": { "get": { "tags": [ "Snapshots" ], "summary": "List Snapshots", "operationId": "list_snapshots_v1_snapshots_get", "parameters": [ { "required": false, "schema": { "title": "Instance Id", "type": "string" }, "name": "instance_id", "in": "query" }, { "required": false, "schema": { "title": "Is Automated Backup", "type": "boolean", "default": false }, "name": "is_automated_backup", "in": "query" }, { "required": false, "schema": { "$ref": "#/components/schemas/SnapshotStatusEnum" }, "name": "status", "in": "query" }, { "required": false, "schema": { "title": "Limit", "type": "integer" }, "name": "limit", "in": "query" }, { "required": false, "schema": { "title": "Page", "type": "integer", "default": 1 }, "name": "page", "in": "query" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSnapshotsResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Snapshots" ], "summary": "Create Snapshot", "operationId": "create_snapshot_v1_snapshots_post", "parameters": [ { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TakeSnapshotRequestSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TakeSnapshotResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/snapshots/{id}": { "get": { "tags": [ "Snapshots" ], "summary": "Get Snapshot Detail", "operationId": "get_snapshot_detail_v1_snapshots__id__get", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string" }, "name": "id", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSnapshotResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Snapshots" ], "summary": "Delete Snapshot", "operationId": "delete_snapshot_v1_snapshots__id__delete", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string" }, "name": "id", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/snapshots/{id}/restore": { "post": { "tags": [ "Snapshots" ], "summary": "Restore Snapshot", "operationId": "restore_snapshot_v1_snapshots__id__restore_post", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string" }, "name": "id", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/backups": { "get": { "tags": [ "Backups" ], "summary": "List Backup Profiles", "operationId": "list_backup_profiles_v1_backups_get", "parameters": [ { "required": false, "schema": { "$ref": "#/components/schemas/BackupProfileStatusEnum" }, "name": "status", "in": "query" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBackupProfileResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Backups" ], "summary": "Update Backup Profile", "operationId": "update_backup_profile_v1_backups_put", "parameters": [ { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBackupProfileRequestSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupProfileResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Backups" ], "summary": "Create Backup Profile", "operationId": "create_backup_profile_v1_backups_post", "parameters": [ { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBackupProfileRequestSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupProfileResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/backups/{instanceId}": { "get": { "tags": [ "Backups" ], "summary": "Get Backup Profile", "operationId": "get_backup_profile_v1_backups__instanceId__get", "parameters": [ { "required": true, "schema": { "title": "Instanceid", "type": "string" }, "name": "instanceId", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupProfileResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Backups" ], "summary": "Delete Backup Profile", "operationId": "delete_backup_profile_v1_backups__instanceId__delete", "parameters": [ { "required": true, "schema": { "title": "Instanceid", "type": "string" }, "name": "instanceId", "in": "path" }, { "required": true, "schema": { "title": "Api-Token", "type": "string" }, "name": "API-Token", "in": "header" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AddFloatingIPRequestSchema": { "title": "AddFloatingIPRequestSchema", "required": [ "regionId", "count" ], "type": "object", "properties": { "regionId": { "title": "Regionid", "type": "string" }, "count": { "title": "Count", "type": "integer" } } }, "AddFloatingIpResponseSchema": { "title": "AddFloatingIpResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/gateway__billing__floating_ip__schema__FloatingIPDetailSchema" } } } }, "AddonActiveness": { "title": "AddonActiveness", "required": [ "id", "isActive" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "isActive": { "title": "Isactive", "type": "boolean" } } }, "AddonPricingTypeEnum": { "title": "AddonPricingTypeEnum", "enum": [ "FIXED", "PLAN_BASED" ], "type": "string", "description": "An enumeration." }, "ApplicationSchema": { "title": "ApplicationSchema", "required": [ "name", "price", "pricingType", "isActive", "tag", "isExperimental", "description", "osFamily", "osList" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "price": { "title": "Price", "type": "number" }, "pricingType": { "$ref": "#/components/schemas/AddonPricingTypeEnum" }, "isActive": { "title": "Isactive", "type": "boolean" }, "logoUrl": { "title": "Logourl", "type": "string" }, "tag": { "title": "Tag", "type": "string" }, "isExperimental": { "title": "Isexperimental", "type": "boolean" }, "description": { "title": "Description", "type": "string" }, "osFamily": { "title": "Osfamily", "type": "string" }, "osList": { "title": "Oslist", "type": "array", "items": { "type": "string" } } } }, "BackupProfileResponseSchema": { "title": "BackupProfileResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/BackupProfileSchema" } } }, "BackupProfileSchema": { "title": "BackupProfileSchema", "required": [ "instanceId", "status", "backupFiles" ], "type": "object", "properties": { "instanceId": { "title": "Instanceid", "type": "string" }, "instanceData": { "$ref": "#/components/schemas/SnapshotMetadataSchema" }, "status": { "title": "Status", "type": "string" }, "monthlyPrice": { "title": "Monthlyprice", "type": "number" }, "feePercentage": { "title": "Feepercentage", "type": "integer" }, "scheduleFrequency": { "$ref": "#/components/schemas/ScheduleFrequencyEnum" }, "scheduleWeekDays": { "type": "array", "items": { "$ref": "#/components/schemas/WeekdaysEnum" } }, "maxFiles": { "title": "Maxfiles", "type": "integer" }, "periodId": { "title": "Periodid", "type": "integer" }, "lastSuccessfulBackupTime": { "title": "Lastsuccessfulbackuptime", "type": "integer" }, "backupFiles": { "title": "Backupfiles", "type": "array", "items": { "$ref": "#/components/schemas/SnapshotDetailSchema" } }, "createdAt": { "title": "Createdat", "type": "integer" } } }, "BackupProfileStatusEnum": { "title": "BackupProfileStatusEnum", "enum": [ "active", "inactive", "pending" ], "type": "string", "description": "An enumeration." }, "BaseInstanceDetailSchema": { "title": "BaseInstanceDetailSchema", "required": [ "id", "hostname", "vcpuCount", "ram", "disk", "class" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "A unique ID for the VPS Instance." }, "hostname": { "title": "Hostname", "type": "string", "description": "Host Name" }, "vcpuCount": { "title": "Vcpucount", "type": "integer", "description": "Number of vCPUs." }, "ram": { "title": "Ram", "type": "integer", "description": "The amount of RAM in MB." }, "disk": { "title": "Disk", "type": "integer", "description": "The size of the disk in GB." }, "insertedAt": { "title": "Insertedat", "type": "string", "description": "Creation timestamp" }, "osId": { "title": "Osid", "type": "string" }, "isoId": { "title": "Isoid", "type": "string" }, "fromImage": { "title": "Fromimage", "type": "string" }, "os": { "$ref": "#/components/schemas/OsSchema" }, "region": { "title": "Region", "type": "string", "description": "The region where the Instance is located." }, "userId": { "title": "Userid", "type": "string" }, "appId": { "title": "Appid", "type": "string" }, "status": { "title": "Status", "type": "string", "description": "The current status." }, "mainIp": { "title": "Mainip", "type": "string", "description": "The main IPv4 address." }, "mainIpv6": { "title": "Mainipv6", "type": "string", "description": "The IPv6 address." }, "productId": { "title": "Productid", "type": "string", "description": "A unique ID for the VPS Product" }, "networkStatus": { "title": "Networkstatus", "type": "string", "description": "The current network_status, valid values are: initializing, active and suspended" }, "discountPercent": { "title": "Discountpercent", "type": "integer" }, "attachIso": { "title": "Attachiso", "type": "boolean" }, "extraResource": { "$ref": "#/components/schemas/ExtraResourceDetailSchema" }, "class": { "allOf": [ { "$ref": "#/components/schemas/InstanceClassEnum" } ], "description": "the class name for instance base, gpu, ..." }, "ocaData": { "title": "Ocadata", "anyOf": [ { "type": "array", "items": {} }, { "type": "object" } ] }, "isDdosProtected": { "title": "Isddosprotected", "type": "boolean" }, "customerNote": { "title": "Customernote", "type": "string" }, "adminNote": { "title": "Adminnote", "type": "string" } } }, "BillingCycleEnum": { "title": "BillingCycleEnum", "enum": [ "hourly", "monthly", "quarterly", "semi-annually", "annually" ], "type": "string", "description": "An enumeration." }, "Body_change_os_v1_instances__instanceId__change_os_post": { "title": "Body_change_os_v1_instances__instanceId__change_os_post", "required": [ "osId" ], "type": "object", "properties": { "osId": { "title": "Osid", "type": "string" } } }, "BulkSubscriptionRefundDetail": { "title": "BulkSubscriptionRefundDetail", "required": [ "instanceId", "usedDays", "remainingDays", "refundAmount" ], "type": "object", "properties": { "instanceId": { "title": "Instanceid", "type": "string" }, "usedDays": { "title": "Useddays", "type": "integer" }, "remainingDays": { "title": "Remainingdays", "type": "integer" }, "refundAmount": { "title": "Refundamount", "type": "number" } } }, "BulkSubscriptionRefundRequestSchema": { "title": "BulkSubscriptionRefundRequestSchema", "required": [ "ids" ], "type": "object", "properties": { "ids": { "title": "Ids", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "List of instance IDs" } } }, "BulkSubscriptionRefundResponseSchema": { "title": "BulkSubscriptionRefundResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/BulkSubscriptionRefundDetail" } } } }, "ChangeOsResponseData": { "title": "ChangeOsResponseData", "required": [ "password" ], "type": "object", "properties": { "password": { "title": "Password", "type": "string" } } }, "ChangeOsResponseSchema": { "title": "ChangeOsResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ChangeOsResponseData" } } }, "CreateBackupProfileRequestSchema": { "title": "CreateBackupProfileRequestSchema", "required": [ "instanceId", "scheduleFrequency", "periodId" ], "type": "object", "properties": { "instanceId": { "title": "Instanceid", "type": "string" }, "scheduleFrequency": { "title": "Schedulefrequency", "type": "string" }, "scheduleWeekDays": { "type": "array", "items": { "$ref": "#/components/schemas/WeekdaysEnum" } }, "periodId": { "title": "Periodid", "type": "integer" } } }, "CreateFloatIpResponseSchema": { "title": "CreateFloatIpResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "title": "Data", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/developer_api__instances__schema__FloatingIPDetailSchema" } }, { "type": "string" } ] } } }, "CreateInstanceRequestSchema": { "title": "CreateInstanceRequestSchema", "required": [ "hostnames", "region" ], "type": "object", "properties": { "hostnames": { "title": "Hostnames", "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "string" } }, "productId": { "title": "Productid", "type": "string" }, "customerId": { "title": "Customerid", "type": "string" }, "appId": { "title": "Appid", "type": "string" }, "assignIpv6": { "title": "Assignipv6", "type": "boolean" }, "assignIpv4": { "title": "Assignipv4", "type": "boolean" }, "isDdosProtected": { "title": "Isddosprotected", "type": "boolean" }, "billingCycle": { "allOf": [ { "$ref": "#/components/schemas/BillingCycleEnum" } ], "default": "hourly" }, "isSubscriptionAutoRenewEnabled": { "title": "Issubscriptionautorenewenabled", "type": "boolean", "default": true }, "isoId": { "title": "Isoid", "type": "string" }, "osId": { "title": "Osid", "type": "string" }, "osName": { "title": "Osname", "type": "string" }, "sshKeyIds": { "title": "Sshkeyids", "type": "array", "items": { "type": "integer" } }, "featureIds": { "type": "array", "items": { "$ref": "#/components/schemas/InstanceFeatureEnum" } }, "floatingIPCount": { "title": "Floatingipcount", "maximum": 5.0, "minimum": 0.0, "type": "integer", "default": 0 }, "extraResource": { "$ref": "#/components/schemas/ExtraResourceDetailSchema" }, "region": { "title": "Region", "type": "string" }, "class": { "allOf": [ { "$ref": "#/components/schemas/InstanceClassEnum" } ], "default": "default" }, "fromSnapshot": { "title": "Fromsnapshot", "type": "string" } } }, "CreateInstanceResponseData": { "title": "CreateInstanceResponseData", "required": [ "instances" ], "type": "object", "properties": { "instances": { "title": "Instances", "type": "array", "items": { "$ref": "#/components/schemas/CreateSingleInstanceResponseSchema" } }, "floatIps": { "title": "Floatips", "allOf": [ { "$ref": "#/components/schemas/CreateFloatIpResponseSchema" } ], "default": [] } } }, "CreateInstanceResponseSchema": { "title": "CreateInstanceResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/CreateInstanceResponseData" } } }, "CreateSingleInstanceResponseSchema": { "title": "CreateSingleInstanceResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "title": "Data", "anyOf": [ { "$ref": "#/components/schemas/InstanceDetailSchema" }, { "$ref": "#/components/schemas/InstanceCreationFailureDetailSchema" } ] } } }, "DetailedProductSchema": { "title": "DetailedProductSchema", "required": [ "regionId", "planId", "isActive", "networkMaxRate", "networkMaxRate95", "id", "plan", "overallActiveness" ], "type": "object", "properties": { "regionId": { "title": "Regionid", "type": "string" }, "planId": { "title": "Planid", "type": "string" }, "isActive": { "title": "Isactive", "type": "boolean" }, "isOutOfSales": { "title": "Isoutofsales", "type": "boolean", "default": false }, "networkMaxRate": { "title": "Networkmaxrate", "type": "number" }, "networkMaxRate95": { "title": "Networkmaxrate95", "type": "number" }, "discountPercent": { "title": "Discountpercent", "type": "integer", "default": 0 }, "remainingActualStock": { "title": "Remainingactualstock", "type": "integer" }, "remainingPreorderCapacity": { "title": "Remainingpreordercapacity", "type": "integer" }, "id": { "title": "Id", "type": "string" }, "plan": { "$ref": "#/components/schemas/PlanSchema" }, "overallActiveness": { "title": "Overallactiveness", "type": "boolean" }, "ddosActiveness": { "title": "Ddosactiveness", "type": "boolean" }, "priceItems": { "title": "Priceitems", "type": "array", "items": { "$ref": "#/components/schemas/PriceItem" } }, "oses": { "title": "Oses", "type": "array", "items": { "$ref": "#/components/schemas/OsActiveness" } }, "features": { "title": "Features", "type": "array", "items": { "$ref": "#/components/schemas/AddonActiveness" } }, "apps": { "title": "Apps", "type": "array", "items": { "$ref": "#/components/schemas/AddonActiveness" } } } }, "DownloadImageRequestSchema": { "title": "DownloadImageRequestSchema", "required": [ "name", "url", "regionId" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "url": { "title": "Url", "type": "string" }, "format": { "title": "Format", "type": "string" }, "decompress": { "title": "Decompress", "type": "string" }, "regionId": { "title": "Regionid", "type": "string" } } }, "DownloadImageResponseSchema": { "title": "DownloadImageResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SingleImageSchema" } } }, "DownloadIsoRequestSchema": { "title": "DownloadIsoRequestSchema", "required": [ "name", "url", "regionId" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "url": { "title": "Url", "type": "string" }, "useVirtio": { "title": "Usevirtio", "type": "boolean", "default": true }, "regionId": { "title": "Regionid", "type": "string" } } }, "DownloadIsoResponseSchema": { "title": "DownloadIsoResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SingleIsoSchema" } } }, "ExtraResourceDetailSchema": { "title": "ExtraResourceDetailSchema", "type": "object", "properties": { "cpu": { "title": "Cpu", "type": "integer" }, "ramInGB": { "title": "Ramingb", "type": "integer" }, "diskInGB": { "title": "Diskingb", "type": "integer" }, "bandwidthInTB": { "title": "Bandwidthintb", "type": "integer" } } }, "GetImageDetailResponseSchema": { "title": "GetImageDetailResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SingleImageSchema" } } }, "GetInstanceResponseSchema": { "title": "GetInstanceResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/InstanceDetail" } } }, "GetIsoDetailResponseSchema": { "title": "GetIsoDetailResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SingleIsoSchema" } } }, "GetSnapshotResponseSchema": { "title": "GetSnapshotResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SnapshotDetailSchema" } } }, "GetSubscriptionRefundDetailResponseSchema": { "title": "GetSubscriptionRefundDetailResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SubscriptionRefundDetail" } } }, "HTTPValidationError": { "title": "HTTPValidationError", "type": "object", "properties": { "detail": { "title": "Detail", "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } } } }, "IaasSpecificationSchema": { "title": "IaasSpecificationSchema", "required": [ "cpu", "ram", "ramInMB", "storage", "bandwidthInTB" ], "type": "object", "properties": { "cpu": { "title": "Cpu", "type": "number" }, "ram": { "title": "Ram", "type": "number" }, "ramInMB": { "title": "Raminmb", "type": "number" }, "storage": { "title": "Storage", "type": "number" }, "bandwidthInTB": { "title": "Bandwidthintb", "type": "number" } } }, "ImageStatusEnum": { "title": "ImageStatusEnum", "enum": [ "DOWNLOADING", "READY", "FAILED", "DELETED" ], "type": "string", "description": "An enumeration." }, "InstanceClassEnum": { "title": "InstanceClassEnum", "enum": [ "default", "cpu-optimized", "gpu-provided" ], "type": "string", "description": "An enumeration." }, "InstanceCreationFailureDetailSchema": { "title": "InstanceCreationFailureDetailSchema", "required": [ "error", "hostname", "vcpuCount", "ram", "disk" ], "type": "object", "properties": { "error": { "title": "Error", "type": "string" }, "hostname": { "title": "Hostname", "type": "string" }, "vcpuCount": { "title": "Vcpucount", "type": "integer" }, "ram": { "title": "Ram", "type": "integer" }, "disk": { "title": "Disk", "type": "integer" } } }, "InstanceDetail": { "title": "InstanceDetail", "required": [ "id", "hostname", "vcpuCount", "ram", "disk", "class", "remainingRepairsToday", "dailyRepairLimit" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "A unique ID for the VPS Instance." }, "hostname": { "title": "Hostname", "type": "string", "description": "Host Name" }, "vcpuCount": { "title": "Vcpucount", "type": "integer", "description": "Number of vCPUs." }, "ram": { "title": "Ram", "type": "integer", "description": "The amount of RAM in MB." }, "disk": { "title": "Disk", "type": "integer", "description": "The size of the disk in GB." }, "insertedAt": { "title": "Insertedat", "type": "string", "description": "Creation timestamp" }, "osId": { "title": "Osid", "type": "string" }, "isoId": { "title": "Isoid", "type": "string" }, "fromImage": { "title": "Fromimage", "type": "string" }, "os": { "$ref": "#/components/schemas/OsSchema" }, "region": { "title": "Region", "type": "string", "description": "The region where the Instance is located." }, "userId": { "title": "Userid", "type": "string" }, "appId": { "title": "Appid", "type": "string" }, "status": { "title": "Status", "type": "string", "description": "The current status." }, "mainIp": { "title": "Mainip", "type": "string", "description": "The main IPv4 address." }, "mainIpv6": { "title": "Mainipv6", "type": "string", "description": "The IPv6 address." }, "productId": { "title": "Productid", "type": "string", "description": "A unique ID for the VPS Product" }, "networkStatus": { "title": "Networkstatus", "type": "string", "description": "The current network_status, valid values are: initializing, active and suspended" }, "discountPercent": { "title": "Discountpercent", "type": "integer" }, "attachIso": { "title": "Attachiso", "type": "boolean" }, "extraResource": { "$ref": "#/components/schemas/ExtraResourceDetailSchema" }, "class": { "allOf": [ { "$ref": "#/components/schemas/InstanceClassEnum" } ], "description": "the class name for instance base, gpu, ..." }, "ocaData": { "title": "Ocadata", "anyOf": [ { "type": "array", "items": {} }, { "type": "object" } ] }, "isDdosProtected": { "title": "Isddosprotected", "type": "boolean" }, "customerNote": { "title": "Customernote", "type": "string" }, "adminNote": { "title": "Adminnote", "type": "string" }, "adminSuspendNote": { "title": "Adminsuspendnote", "type": "string" }, "vnc": { "title": "Vnc", "type": "string" }, "netmaskV4": { "title": "Netmaskv4", "type": "string" }, "gatewayV4": { "title": "Gatewayv4", "type": "string" }, "netmaskV6": { "title": "Netmaskv6", "type": "string" }, "gatewayV6": { "title": "Gatewayv6", "type": "string" }, "sshKeys": { "title": "Sshkeys", "type": "array", "items": { "type": "string" } }, "suspendedByBillingAt": { "title": "Suspendedbybillingat", "type": "string" }, "billingSuspendNote": { "title": "Billingsuspendnote", "type": "string" }, "suspendByAdminAt": { "title": "Suspendbyadminat", "type": "string" }, "vncStatus": { "title": "Vncstatus", "type": "string" }, "defaultPassword": { "title": "Defaultpassword", "type": "string" }, "features": { "title": "Features", "type": "array", "items": { "type": "string" } }, "remainingRepairsToday": { "title": "Remainingrepairstoday", "type": "integer" }, "dailyRepairLimit": { "title": "Dailyrepairlimit", "type": "integer" } } }, "InstanceDetailSchema": { "title": "InstanceDetailSchema", "required": [ "id", "hostname", "vcpuCount", "ram", "disk", "class" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "A unique ID for the VPS Instance." }, "hostname": { "title": "Hostname", "type": "string", "description": "Host Name" }, "vcpuCount": { "title": "Vcpucount", "type": "integer", "description": "Number of vCPUs." }, "ram": { "title": "Ram", "type": "integer", "description": "The amount of RAM in MB." }, "disk": { "title": "Disk", "type": "integer", "description": "The size of the disk in GB." }, "insertedAt": { "title": "Insertedat", "type": "string", "description": "Creation timestamp" }, "osId": { "title": "Osid", "type": "string" }, "isoId": { "title": "Isoid", "type": "string" }, "fromImage": { "title": "Fromimage", "type": "string" }, "os": { "$ref": "#/components/schemas/OsSchema" }, "region": { "title": "Region", "type": "string", "description": "The region where the Instance is located." }, "userId": { "title": "Userid", "type": "string" }, "appId": { "title": "Appid", "type": "string" }, "status": { "title": "Status", "type": "string", "description": "The current status." }, "mainIp": { "title": "Mainip", "type": "string", "description": "The main IPv4 address." }, "mainIpv6": { "title": "Mainipv6", "type": "string", "description": "The IPv6 address." }, "productId": { "title": "Productid", "type": "string", "description": "A unique ID for the VPS Product" }, "networkStatus": { "title": "Networkstatus", "type": "string", "description": "The current network_status, valid values are: initializing, active and suspended" }, "discountPercent": { "title": "Discountpercent", "type": "integer" }, "attachIso": { "title": "Attachiso", "type": "boolean" }, "extraResource": { "$ref": "#/components/schemas/ExtraResourceDetailSchema" }, "class": { "allOf": [ { "$ref": "#/components/schemas/InstanceClassEnum" } ], "description": "the class name for instance base, gpu, ..." }, "ocaData": { "title": "Ocadata", "anyOf": [ { "type": "array", "items": {} }, { "type": "object" } ] }, "isDdosProtected": { "title": "Isddosprotected", "type": "boolean" }, "customerNote": { "title": "Customernote", "type": "string" }, "adminNote": { "title": "Adminnote", "type": "string" }, "adminSuspendNote": { "title": "Adminsuspendnote", "type": "string" }, "vnc": { "title": "Vnc", "type": "string" }, "netmaskV6": { "title": "Netmaskv6", "type": "string" }, "gatewayV6": { "title": "Gatewayv6", "type": "string" }, "netmaskV4": { "title": "Netmaskv4", "type": "string" }, "gatewayV4": { "title": "Gatewayv4", "type": "string" }, "sshKeys": { "title": "Sshkeys", "type": "array", "items": { "type": "string" } }, "suspendedByBillingAt": { "title": "Suspendedbybillingat", "type": "string" }, "suspendByAdminAt": { "title": "Suspendbyadminat", "type": "string" }, "billingSuspendNote": { "title": "Billingsuspendnote", "type": "string" }, "vncStatus": { "title": "Vncstatus", "type": "string" }, "defaultPassword": { "title": "Defaultpassword", "type": "string" }, "features": { "title": "Features", "type": "array", "items": { "type": "string" } } } }, "InstanceFeatureEnum": { "title": "InstanceFeatureEnum", "enum": [ "nested", "ide", "metatrader4", "metatrader5", "vpn-vless", "vpn-vmess", "vpn-ss", "vpn-mtproto", "monitoring" ], "type": "string", "description": "An enumeration." }, "IsoStatusEnum": { "title": "IsoStatusEnum", "enum": [ "DOWNLOADING", "READY", "FAILED", "DELETED" ], "type": "string", "description": "An enumeration." }, "ListApplicationResponseSchema": { "title": "ListApplicationResponseSchema", "required": [ "detail", "code" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/ApplicationSchema" } } } }, "ListBackupProfileResponseSchema": { "title": "ListBackupProfileResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/BackupProfileSchema" } } } }, "ListFloatingIpDataSchema": { "title": "ListFloatingIpDataSchema", "required": [ "items", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "title": "Items", "type": "array", "items": { "$ref": "#/components/schemas/gateway__billing__floating_ip__schema__FloatingIPDetailSchema" } }, "pageSize": { "title": "Pagesize", "type": "integer" }, "totalCount": { "title": "Totalcount", "type": "integer" }, "totalPages": { "title": "Totalpages", "type": "integer" } } }, "ListFloatingIpResponseSchema": { "title": "ListFloatingIpResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ListFloatingIpDataSchema" } } }, "ListImageDataSchema": { "title": "ListImageDataSchema", "required": [ "items", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "title": "Items", "type": "array", "items": { "$ref": "#/components/schemas/SingleImageSchema" } }, "pageSize": { "title": "Pagesize", "type": "integer" }, "totalCount": { "title": "Totalcount", "type": "integer" }, "totalPages": { "title": "Totalpages", "type": "integer" } } }, "ListImageResponseSchema": { "title": "ListImageResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ListImageDataSchema" } } }, "ListInstanceResponseData": { "title": "ListInstanceResponseData", "required": [ "instances" ], "type": "object", "properties": { "bookmark": { "title": "Bookmark", "type": "string" }, "instances": { "title": "Instances", "type": "array", "items": { "$ref": "#/components/schemas/BaseInstanceDetailSchema" } } } }, "ListInstanceResponseSchema": { "title": "ListInstanceResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ListInstanceResponseData" } } }, "ListIsoDataSchema": { "title": "ListIsoDataSchema", "required": [ "items", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "title": "Items", "type": "array", "items": { "$ref": "#/components/schemas/SingleIsoSchema" } }, "pageSize": { "title": "Pagesize", "type": "integer" }, "totalCount": { "title": "Totalcount", "type": "integer" }, "totalPages": { "title": "Totalpages", "type": "integer" } } }, "ListIsoResponseSchema": { "title": "ListIsoResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ListIsoDataSchema" } } }, "ListRegionResponse": { "title": "ListRegionResponse", "required": [ "detail", "code" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/RegionSchema" } } } }, "ListSSHKeysResponseSchema": { "title": "ListSSHKeysResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/SSHKeyReadSchema" } } } }, "ListSnapshotDataSchema": { "title": "ListSnapshotDataSchema", "required": [ "items" ], "type": "object", "properties": { "items": { "title": "Items", "type": "array", "items": { "$ref": "#/components/schemas/SnapshotDetailSchema" } }, "pageSize": { "title": "Pagesize", "type": "integer" }, "totalCount": { "title": "Totalcount", "type": "integer" }, "totalPages": { "title": "Totalpages", "type": "integer" } } }, "ListSnapshotsResponseSchema": { "title": "ListSnapshotsResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ListSnapshotDataSchema" } } }, "OsActiveness": { "title": "OsActiveness", "required": [ "osId", "isActive" ], "type": "object", "properties": { "osId": { "title": "Osid", "type": "string" }, "isActive": { "title": "Isactive", "type": "boolean" } } }, "OsListSchema": { "title": "OsListSchema", "type": "object", "properties": { "os": { "title": "Os", "type": "array", "items": { "$ref": "#/components/schemas/OsSchema" } } } }, "OsResponseSchema": { "title": "OsResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/OsListSchema" } } }, "OsSchema": { "title": "OsSchema", "required": [ "id", "arch", "family", "name", "minRam", "isDefault", "isActive" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The Operating System id." }, "arch": { "title": "Arch", "type": "string", "description": "The Operating System architecture." }, "family": { "title": "Family", "type": "string", "description": "The Operating System family." }, "name": { "title": "Name", "type": "string", "description": "The Operating System description." }, "minRam": { "title": "Minram", "type": "string", "description": "The minimum required ram." }, "isDefault": { "title": "Isdefault", "type": "boolean", "description": "is default os" }, "isActive": { "title": "Isactive", "type": "boolean", "description": "is available for creation or is only available for resize." } } }, "PlanSchema": { "title": "PlanSchema", "required": [ "id", "specification", "isActive" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "type": { "$ref": "#/components/schemas/developer_api__products__schema__PlanTypeEnum" }, "gpuName": { "title": "Gpuname", "type": "string" }, "gpuQuantity": { "title": "Gpuquantity", "type": "integer" }, "specification": { "$ref": "#/components/schemas/IaasSpecificationSchema" }, "isActive": { "title": "Isactive", "type": "boolean" } } }, "PriceItem": { "title": "PriceItem", "required": [ "name", "hourlyPrice", "monthlyPrice", "hourlyPriceWithoutDiscount", "monthlyPriceWithoutDiscount", "discountPercent", "id" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "hourlyPrice": { "title": "Hourlyprice", "type": "number" }, "monthlyPrice": { "title": "Monthlyprice", "type": "number" }, "hourlyPriceWithoutDiscount": { "title": "Hourlypricewithoutdiscount", "type": "number" }, "monthlyPriceWithoutDiscount": { "title": "Monthlypricewithoutdiscount", "type": "number" }, "discountPercent": { "title": "Discountpercent", "type": "integer" }, "id": { "title": "Id", "type": "string" } } }, "ProductResponseSchema": { "title": "ProductResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/DetailedProductSchema" } } } }, "RegionConfigDetailSchema": { "title": "RegionConfigDetailSchema", "required": [ "supportIpv6", "supportRegularCpu", "supportHighFrequencyCpu", "supportMonitoring", "supportGPU", "supportCustomPlan", "ramThresholdInGB", "ipThreshold", "diskThresholdInGB" ], "type": "object", "properties": { "supportIpv6": { "title": "Supportipv6", "type": "boolean" }, "supportRegularCpu": { "title": "Supportregularcpu", "type": "boolean" }, "supportHighFrequencyCpu": { "title": "Supporthighfrequencycpu", "type": "boolean" }, "supportMonitoring": { "title": "Supportmonitoring", "type": "boolean" }, "supportGPU": { "title": "Supportgpu", "type": "boolean" }, "supportCustomPlan": { "title": "Supportcustomplan", "type": "boolean" }, "ramThresholdInGB": { "title": "Ramthresholdingb", "type": "integer" }, "ipThreshold": { "title": "Ipthreshold", "type": "integer" }, "diskThresholdInGB": { "title": "Diskthresholdingb", "type": "integer" }, "supportDdosIpv4": { "title": "Supportddosipv4", "type": "boolean" }, "ddosIpv4Threshold": { "title": "Ddosipv4Threshold", "type": "integer" } } }, "RegionSchema": { "title": "RegionSchema", "required": [ "id", "name", "abbr", "image", "isActive", "isOutOfStock", "overallActiveness", "isPremium", "isHidden", "hasOffsetPrice", "position", "config" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "abbr": { "title": "Abbr", "type": "string" }, "image": { "title": "Image", "type": "string" }, "isActive": { "title": "Isactive", "type": "boolean" }, "isOutOfStock": { "title": "Isoutofstock", "type": "boolean" }, "overallActiveness": { "title": "Overallactiveness", "type": "boolean" }, "ddosActiveness": { "title": "Ddosactiveness", "type": "boolean" }, "isPremium": { "title": "Ispremium", "type": "boolean" }, "isHidden": { "title": "Ishidden", "type": "boolean" }, "hasOffsetPrice": { "title": "Hasoffsetprice", "type": "boolean" }, "maxDiscountPercent": { "title": "Maxdiscountpercent", "type": "integer" }, "position": { "title": "Position", "type": "object", "additionalProperties": { "type": "integer" } }, "config": { "$ref": "#/components/schemas/RegionConfigDetailSchema" } } }, "ResizeInstanceRequestSchema": { "title": "ResizeInstanceRequestSchema", "required": [ "instanceId", "type" ], "type": "object", "properties": { "instanceId": { "title": "Instanceid", "type": "string" }, "type": { "$ref": "#/components/schemas/developer_api__instances__schema__PlanTypeEnum" }, "productId": { "title": "Productid", "type": "string" }, "regionId": { "title": "Regionid", "type": "string" }, "extraResource": { "$ref": "#/components/schemas/ExtraResourceDetailSchema" } } }, "ResizeInstanceResponseData": { "title": "ResizeInstanceResponseData", "required": [ "id", "hostname", "status", "mainIp", "userId", "region", "extraResource" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "password": { "title": "Password", "type": "string" }, "hostname": { "title": "Hostname", "type": "string" }, "status": { "title": "Status", "type": "string" }, "mainIp": { "title": "Mainip", "type": "string" }, "productId": { "title": "Productid", "type": "string" }, "disk": { "title": "Disk", "type": "number" }, "vcpuCount": { "title": "Vcpucount", "type": "number" }, "features": { "title": "Features", "type": "array", "items": { "type": "string" }, "default": [] }, "userId": { "title": "Userid", "type": "string" }, "ram": { "title": "Ram", "type": "number" }, "region": { "title": "Region", "type": "string" }, "extraResource": { "$ref": "#/components/schemas/ExtraResourceDetailSchema" } } }, "ResizeInstanceResponseSchema": { "title": "ResizeInstanceResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ResizeInstanceResponseData" } } }, "SSHKeyReadSchema": { "title": "SSHKeyReadSchema", "required": [ "name", "publicKey", "customerId", "id" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "publicKey": { "title": "Publickey", "type": "string" }, "customerId": { "title": "Customerid", "type": "string", "format": "uuid4" }, "id": { "title": "Id", "type": "integer" } } }, "SSHKeyWriteSchema": { "title": "SSHKeyWriteSchema", "required": [ "name", "publicKey" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "publicKey": { "title": "Publickey", "type": "string" }, "customerId": { "title": "Customerid", "type": "string" } } }, "ScheduleFrequencyEnum": { "title": "ScheduleFrequencyEnum", "enum": [ "daily", "weekly" ], "type": "string", "description": "An enumeration." }, "SingleImageSchema": { "title": "SingleImageSchema", "required": [ "id", "name", "url", "regionId", "status", "createdAt", "createdBy" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "url": { "title": "Url", "type": "string" }, "format": { "title": "Format", "type": "string" }, "decompress": { "title": "Decompress", "type": "string" }, "regionId": { "title": "Regionid", "type": "string" }, "userId": { "title": "Userid", "type": "string" }, "status": { "$ref": "#/components/schemas/ImageStatusEnum" }, "size": { "title": "Size", "type": "integer" }, "virtualSize": { "title": "Virtualsize", "type": "integer" }, "createdAt": { "title": "Createdat", "type": "number" }, "createdBy": { "title": "Createdby", "type": "string" }, "deletedAt": { "title": "Deletedat", "type": "number" }, "deletedBy": { "title": "Deletedby", "type": "number" } } }, "SingleIsoSchema": { "title": "SingleIsoSchema", "required": [ "name", "url", "regionId", "id", "status", "createdAt", "createdBy" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "url": { "title": "Url", "type": "string" }, "useVirtio": { "title": "Usevirtio", "type": "boolean", "default": true }, "regionId": { "title": "Regionid", "type": "string" }, "userId": { "title": "Userid", "type": "string" }, "id": { "title": "Id", "type": "string" }, "status": { "$ref": "#/components/schemas/IsoStatusEnum" }, "size": { "title": "Size", "type": "integer" }, "createdAt": { "title": "Createdat", "type": "number" }, "createdBy": { "title": "Createdby", "type": "string" }, "deletedAt": { "title": "Deletedat", "type": "number" }, "deletedBy": { "title": "Deletedby", "type": "number" } } }, "SnapshotDetailSchema": { "title": "SnapshotDetailSchema", "required": [ "id", "name", "status", "isInstanceDeleted", "instanceId", "userId" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "size": { "title": "Size", "type": "integer" }, "status": { "$ref": "#/components/schemas/SnapshotStatusEnum" }, "lastRestoredAt": { "title": "Lastrestoredat", "type": "integer" }, "createdAt": { "title": "Createdat", "type": "integer" }, "isInstanceDeleted": { "title": "Isinstancedeleted", "type": "boolean" }, "productId": { "title": "Productid", "type": "string" }, "instanceId": { "title": "Instanceid", "type": "string" }, "userId": { "title": "Userid", "type": "string" }, "regionId": { "title": "Regionid", "type": "string" }, "metadata": { "$ref": "#/components/schemas/SnapshotMetadataSchema" } } }, "SnapshotMetadataSchema": { "title": "SnapshotMetadataSchema", "required": [ "hostname", "networkMaxrate", "networkMaxrate95" ], "type": "object", "properties": { "ip": { "title": "Ip", "type": "string" }, "ipv6": { "title": "Ipv6", "type": "string" }, "appId": { "title": "Appid", "type": "string" }, "billingCycle": { "title": "Billingcycle", "type": "string" }, "extraRamInGb": { "title": "Extraramingb", "type": "number" }, "extraDiskInGb": { "title": "Extradiskingb", "type": "number" }, "extraBandwidthInTb": { "title": "Extrabandwidthintb", "type": "number" }, "hostname": { "title": "Hostname", "type": "string" }, "vCpuCount": { "title": "Vcpucount", "type": "integer" }, "extraVCpuCount": { "title": "Extravcpucount", "type": "integer" }, "ram": { "title": "Ram", "type": "integer" }, "extraRam": { "title": "Extraram", "type": "integer" }, "disk": { "title": "Disk", "type": "integer" }, "extraDisk": { "title": "Extradisk", "type": "integer" }, "features": { "title": "Features", "type": "array", "items": { "type": "string" } }, "networkMaxrate": { "title": "Networkmaxrate", "type": "integer" }, "networkMaxrate95": { "title": "Networkmaxrate95", "type": "integer" }, "osId": { "title": "Osid", "type": "string" }, "isoId": { "title": "Isoid", "type": "string" }, "fromImage": { "title": "Fromimage", "type": "string" }, "instanceClass": { "title": "Instanceclass", "type": "string" } } }, "SnapshotStatusEnum": { "title": "SnapshotStatusEnum", "enum": [ "ACTIVE", "IN_PROGRESS", "FAILED", "RESTORING" ], "type": "string", "description": "An enumeration." }, "SubscriptionRefundDetail": { "title": "SubscriptionRefundDetail", "type": "object", "properties": { "usedDays": { "title": "Useddays", "type": "integer" }, "refundAmount": { "title": "Refundamount", "type": "integer" } } }, "TakeSnapshotRequestSchema": { "title": "TakeSnapshotRequestSchema", "required": [ "instanceId" ], "type": "object", "properties": { "instanceId": { "title": "Instanceid", "type": "string" } } }, "TakeSnapshotResponseSchema": { "title": "TakeSnapshotResponseSchema", "required": [ "detail", "code", "data" ], "type": "object", "properties": { "detail": { "title": "Detail", "type": "string" }, "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SnapshotDetailSchema" } } }, "UpdateBackupProfileRequestSchema": { "title": "UpdateBackupProfileRequestSchema", "required": [ "instanceId", "scheduleFrequency", "periodId" ], "type": "object", "properties": { "instanceId": { "title": "Instanceid", "type": "string" }, "scheduleFrequency": { "title": "Schedulefrequency", "type": "string" }, "scheduleWeekDays": { "type": "array", "items": { "$ref": "#/components/schemas/WeekdaysEnum" } }, "periodId": { "title": "Periodid", "type": "integer" } } }, "UpdateFloatingIPRequestSchema": { "title": "UpdateFloatingIPRequestSchema", "type": "object", "properties": { "autoRenew": { "title": "Autorenew", "type": "boolean" }, "customerNote": { "title": "Customernote", "type": "string" } } }, "ValidationError": { "title": "ValidationError", "required": [ "loc", "msg", "type" ], "type": "object", "properties": { "loc": { "title": "Location", "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } } }, "WeekdaysEnum": { "title": "WeekdaysEnum", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "description": "An enumeration." }, "developer_api__instances__schema__FloatingIPDetailSchema": { "title": "FloatingIPDetailSchema", "required": [ "regionId", "netmask", "address", "type", "gateway", "customerId", "autoRenew", "id", "createdAt", "createdBy", "expiresAt" ], "type": "object", "properties": { "regionId": { "title": "Regionid", "type": "string" }, "netmask": { "title": "Netmask", "type": "string" }, "address": { "title": "Address", "type": "string" }, "type": { "title": "Type", "type": "string" }, "gateway": { "title": "Gateway", "type": "string" }, "customerId": { "title": "Customerid", "type": "string" }, "autoRenew": { "title": "Autorenew", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "customerNote": { "title": "Customernote", "type": "string" }, "adminNote": { "title": "Adminnote", "type": "string" }, "createdAt": { "title": "Createdat", "type": "string" }, "createdBy": { "title": "Createdby", "type": "string" }, "updatedAt": { "title": "Updatedat", "type": "string" }, "updatedBy": { "title": "Updatedby", "type": "string" }, "expiresAt": { "title": "Expiresat", "type": "string" }, "deletedAt": { "title": "Deletedat", "type": "string" }, "deletedBy": { "title": "Deletedby", "type": "string" } } }, "developer_api__instances__schema__PlanTypeEnum": { "title": "PlanTypeEnum", "enum": [ "FIXED", "CUSTOM" ], "type": "string", "description": "An enumeration." }, "developer_api__products__schema__PlanTypeEnum": { "title": "PlanTypeEnum", "enum": [ "default", "cpu-optimized", "gpu-provided" ], "type": "string", "description": "An enumeration." }, "gateway__billing__floating_ip__schema__FloatingIPDetailSchema": { "title": "FloatingIPDetailSchema", "required": [ "regionId", "netmask", "address", "type", "gateway", "customerId", "autoRenew", "id", "createdAt", "createdBy", "expiresAt" ], "type": "object", "properties": { "regionId": { "title": "Regionid", "type": "string" }, "netmask": { "title": "Netmask", "type": "string" }, "address": { "title": "Address", "type": "string" }, "type": { "title": "Type", "type": "string" }, "gateway": { "title": "Gateway", "type": "string" }, "customerId": { "title": "Customerid", "type": "string" }, "autoRenew": { "title": "Autorenew", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "customerNote": { "title": "Customernote", "type": "string" }, "adminNote": { "title": "Adminnote", "type": "string" }, "createdAt": { "title": "Createdat", "type": "string" }, "createdBy": { "title": "Createdby", "type": "string" }, "updatedAt": { "title": "Updatedat", "type": "string" }, "updatedBy": { "title": "Updatedby", "type": "string" }, "expiresAt": { "title": "Expiresat", "type": "string" }, "deletedAt": { "title": "Deletedat", "type": "string" }, "deletedBy": { "title": "Deletedby", "type": "string" } } } } } }