{ "basePath": "/client/v2", "consumes": [ "application/json" ], "definitions": { "ActiveTask": { "properties": { "progress": { "description": "Task completion progress in percentage.", "type": "integer" }, "task_id": { "description": "Unique task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "task_name": { "description": "Name of the task.", "type": "string" } }, "type": "object" }, "AuctionDiscountCampaignListResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of Auction Discount Campaigns.", "items": { "$ref": "#/definitions/AuctionDiscountCampaignModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "AuctionDiscountCampaignModel": { "properties": { "available_config_amount": { "description": "Number of configurations available.", "type": "integer" }, "available_locations": { "description": "List of available location identifiers.", "items": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "type": "array" }, "discount": { "description": "Discount percentage.", "type": "integer" }, "discount_step": { "description": "Discount step percentage.", "type": "integer" }, "discount_step_hours": { "description": "Number of hours between discount steps.", "type": "integer" }, "end_date": { "description": "Auction Discount Campaign end date, Unix timestamp.", "type": "integer" }, "id": { "description": "Auction Discount Campaign identifier.", "type": "integer" }, "is_superlot": { "description": "Indicates whether this is a superlot Auction Discount Campaign.", "type": "boolean" }, "min_config_amount": { "description": "Minimum number of configurations required.", "type": "integer" }, "model": { "description": "Server model for the Auction Discount Campaign.", "type": "string" }, "name": { "description": "Name of the Auction Discount Campaign.", "type": "string" }, "price_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Price collection data." }, "service_uuid": { "description": "Service identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "start_date": { "description": "Auction Discount Campaign start date, Unix timestamp.", "type": "integer" }, "start_discount": { "description": "Starting discount percentage.", "type": "integer" }, "uuid": { "description": "Unique identifier for the Auction Discount Campaign.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "available_config_amount", "available_locations", "discount", "discount_step", "discount_step_hours", "end_date", "is_superlot", "min_config_amount", "model", "name", "price_collection", "start_date", "start_discount", "uuid" ], "type": "object" }, "AuctionDiscountCampaignResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/AuctionDiscountCampaignModel" } ], "description": "Auction Discount Campaign data." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "AuxNetworkInfoModel": { "properties": { "asn": { "description": "BGP ASN number.", "type": "string" }, "availability_zone": { "description": "Switch Availability Zone.", "type": "string" }, "client_ip": { "description": "BGP client IP address.", "type": "string" }, "leaf_pairs": { "description": "Switch leaf pairs.", "items": { "type": "string" }, "type": "array" }, "loopback_ips": { "items": { "description": "Resource loopback IP addresses.", "type": "string" }, "type": "array" }, "mac_address": { "description": "Network interface MAC address.", "type": "string" }, "network_interfaces_ip": { "description": "Network interface IP address.", "type": "string" }, "peer_asn": { "description": "BGP peer ASN number.", "type": "string" }, "peer_ip": { "description": "BGP peer IP address.", "type": "string" }, "peer_name": { "description": "BGP peer name.", "type": "string" }, "subnet": { "description": "Subnet address.", "type": "string" } }, "required": [ "asn", "availability_zone", "client_ip", "mac_address", "network_interfaces_ip", "peer_asn", "peer_ip", "peer_name", "subnet" ], "type": "object" }, "BaseOSConfig": { "allOf": [ { "$ref": "#/definitions/IPv4Input" }, { "$ref": "#/definitions/IPv6Input" }, { "properties": { "arch": { "description": "Operating system architecture.", "example": "x86_64", "type": "string" }, "cloud_init_meta_data": { "description": "Cloud-init metadata configuration.", "type": [ "string", "null" ] }, "cloud_init_user_data": { "description": "Cloud-init user data configuration.", "type": [ "string", "null" ] }, "is_password_deleted": { "description": "Indicates whether the password has been deleted.", "type": [ "boolean", "null" ] }, "os_template": { "description": "Operating system template name.", "example": "ubuntu", "type": "string" }, "user_script": { "description": "Custom user installation script.", "type": [ "string", "null" ] }, "user_ssh_key": { "description": "User SSH public key.", "type": "string" }, "userhostname": { "description": "User hostname.", "type": "string" }, "version": { "description": "Operating system version.", "example": "16.04", "type": "string" } }, "required": [ "arch", "os_template", "userhostname", "version" ], "type": "object" } ] }, "BillingModel": { "properties": { "currency": { "description": "Billing currency code.", "type": "string" }, "current_price_plan": { "allOf": [ { "$ref": "#/definitions/PricePlanModel" } ], "description": "Currently active price plan." }, "has_enough_balance": { "description": "If true, account has sufficient balance.", "type": "boolean" }, "next_price_plan": { "allOf": [ { "$ref": "#/definitions/PricePlanModel" } ], "description": "Next scheduled price plan." }, "price": { "allOf": [ { "$ref": "#/definitions/NextPriceModel" } ], "description": "Pricing details." } }, "required": [ "currency", "current_price_plan", "next_price_plan" ], "type": "object" }, "BillingStatsModel": { "properties": { "unpaid_sum": { "description": "Total unpaid amount.", "type": "number" } }, "required": [ "unpaid_sum" ], "type": "object" }, "BlockStorageBetaFlag": { "properties": { "block_storage_beta_access": { "description": "Indicates whether block storage beta access is enabled.", "type": "boolean" } }, "required": [ "block_storage_beta_access" ], "type": "object" }, "ClientBillingInfoResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/BillingStatsModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ColocationViewModel": { "allOf": [ { "$ref": "#/definitions/ServiceView" }, { "properties": { "addition": { "description": "List of additional services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "available": { "description": "List of available configurations per location.", "items": { "$ref": "#/definitions/ServiceAvailable" }, "type": "array" }, "eol_date": { "description": "End-of-life date as a Unix timestamp.", "type": "integer" }, "is_editable": { "description": "Indicates whether the service configuration is editable.", "type": "boolean" }, "is_manual_erase": { "description": "Indicates whether manual disk erase is required.", "type": "boolean" }, "is_manual_os_install": { "description": "Indicates whether manual OS installation is required.", "type": "boolean" }, "is_order": { "description": "Indicates whether the service is available for ordering.", "type": "boolean" }, "is_preorder": { "description": "Indicates whether the service is available for pre-ordering.", "type": "boolean" }, "is_price_plan_discount_enabled": { "description": "Indicates whether the price plan discount is enabled.", "type": "boolean" }, "is_primary": { "description": "Indicates whether the service is primary.", "type": "boolean" }, "is_qchange": { "description": "Indicates whether the service supports quick change.", "type": "boolean" }, "is_single_prolonged": { "description": "Indicates whether the service has a single renewal period.", "type": "boolean" }, "is_user_discount_enabled": { "description": "Indicates whether the user discount is enabled.", "type": "boolean" }, "location_price_collection": { "allOf": [ { "$ref": "#/definitions/LocationPriceModelView" } ], "description": "Price collection per location." }, "model": { "description": "Service model type.", "type": "string" }, "name": { "description": "Name of the service.", "type": "string" }, "price_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Price collection for the service." }, "price_plan_available": { "description": "List of available price plan UUIDs.", "items": { "type": "string" }, "type": "array" }, "primary": { "description": "List of primary services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "quantity": { "description": "Quantity of service units.", "type": "integer" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "setup_fee_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Setup fee price collection." }, "state": { "description": "Billing state of the service.", "type": "string" }, "tag_list": { "description": "List of tag objects assigned to the service.", "items": { "$ref": "#/definitions/ServiceTagCatalog" }, "type": "array" }, "tags": { "description": "List of tag names assigned to the service.", "items": { "type": "string" }, "type": "array" }, "tariff_line": { "description": "Billing option of the service.", "type": "string" }, "unit": { "description": "Number of rack units.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "addition", "available", "is_order", "is_preorder", "is_price_plan_discount_enabled", "is_primary", "is_single_prolonged", "is_user_discount_enabled", "model", "name", "price_collection", "price_plan_available", "primary", "service_tag", "setup_fee_collection", "state", "tag_list", "tags", "tariff_line", "unit", "uuid" ], "type": "object" } ] }, "ConfigCompactModel": { "properties": { "count": { "type": "integer" }, "feature": { "$ref": "#/definitions/HardmathConfigItemFeatureModel" }, "id": { "type": "integer" } }, "type": "object" }, "ConfigItemPriceModel": { "properties": { "eur": { "minimum": 0.01, "type": "number" }, "kes": { "minimum": 0.01, "type": "number" }, "kzt": { "minimum": 0.01, "type": "number" }, "rub": { "minimum": 0.01, "type": "number" }, "usd": { "minimum": 0.01, "type": "number" }, "uzs": { "minimum": 0.01, "type": "number" } }, "type": "object" }, "Console": { "properties": { "console_enabled": { "description": "Indicates whether the console is enabled.", "type": "boolean" }, "console_info": { "allOf": [ { "$ref": "#/definitions/ConsoleInfo" } ], "description": "Console information." } }, "type": "object" }, "ConsoleInfo": { "properties": { "type": { "description": "Console type.", "type": "string" }, "url": { "description": "Console URL.", "type": "string" } }, "type": "object" }, "ConsoleResolution": { "properties": { "height": { "description": "Console height in pixels.", "type": "number" }, "width": { "description": "Console width in pixels.", "type": "number" } }, "type": "object" }, "CustomOSImageCreateModel": { "properties": { "access_key": { "type": "string" }, "image_href": { "type": "string" }, "login": { "type": "string" }, "os_family_type": { "enum": [ "ubuntu/debian", "windows", "esxi", "other" ], "example": "ubuntu/debian", "type": "string" }, "owner_id": { "type": "integer" }, "secret_key": { "type": "string" }, "storage_type": { "enum": [ "s3", "http", "local" ], "example": "s3", "type": "string" }, "version_name": { "type": "string" } }, "required": [ "image_href", "os_family_type", "owner_id", "storage_type", "version_name" ], "type": "object" }, "CustomOSImageDetailModel": { "properties": { "allowed_fs_types": { "description": "List of allowed filesystem types.", "items": { "type": "string" }, "type": "array" }, "app_name": { "description": "Application name.", "type": "string" }, "app_version": { "description": "Application version.", "type": "string" }, "arch": { "description": "Operating system architecture.", "enum": [ "x86_64", "i386", "aarch64", "aarch64_pi4", "aarch64_m1" ], "example": "x86_64", "type": "string" }, "created": { "type": "integer" }, "default_partitions": { "description": "List of default partitions.", "items": { "$ref": "#/definitions/PartitionModel" }, "type": "array" }, "default_script": { "description": "Default installation script.", "type": "string" }, "excluded_locations": { "description": "List of excluded location identifiers.", "items": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "type": "array" }, "excluded_services": { "description": "List of excluded service identifiers.", "items": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "type": "array" }, "image_href": { "type": "string" }, "image_url": { "description": "Operating system image URL.", "type": [ "string", "null" ] }, "install_script": { "description": "Installation script.", "type": "string" }, "is_ssh_key_allowed": { "description": "Indicates whether SSH keys are allowed.", "type": "boolean" }, "login": { "type": "string" }, "md5": { "type": "string" }, "os_family_type": { "enum": [ "ubuntu/debian", "windows", "esxi", "other" ], "example": "ubuntu/debian", "type": "string" }, "os_name": { "description": "Operating system name.", "enum": [ "Debian", "Ubuntu", "CentOS", "Oracle", "AstraLinux", "AlmaLinux", "Rocky", "SelectOS", "Proxmox", "Opensuse", "VMware ESXi", "Windows Server", "FreeBSD", "Mac OS", "Raspberry Pi OS", "Managed k8s", "Pre-installed Apps", "Custom OS", "No OS - erase all disks", "No OS - boot" ], "example": "Debian", "type": "string" }, "os_value": { "description": "Operating system value.", "enum": [ "debian", "ubuntu", "centos", "oracle", "astralinux", "almalinux", "rocky", "selectos", "proxmox", "opensuse", "esxi", "windows", "freebsd", "macos", "rpios", "mks", "preinstall", "custom", "erase", "noos" ], "example": "debian", "type": "string" }, "outdated": { "description": "Indicates whether the template is outdated.", "type": "boolean" }, "owner_id": { "type": "integer" }, "partitioning": { "description": "Indicates whether custom partitioning is supported.", "type": "boolean" }, "raid": { "description": "List of available RAID configurations.", "items": { "$ref": "#/definitions/RaidModel" }, "type": "array" }, "script_allowed": { "description": "Indicates whether custom scripts are allowed.", "type": "boolean" }, "size": { "type": "integer" }, "state": { "enum": [ "pending", "active", "validating", "error", "hidden", "deleted" ], "example": "pending", "type": "string" }, "storage_type": { "enum": [ "s3", "http", "local" ], "example": "s3", "type": "string" }, "template_version": { "description": "Operating system template version.", "type": "string" }, "updated": { "type": "integer" }, "uuid": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "version_name": { "type": "string" }, "version_value": { "description": "Operating system version value.", "type": "string" } }, "type": "object" }, "CustomOSImageDetailResponse": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/CustomOSImageDetailModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "CustomOSImageListResponse": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/CustomOSImageDetailModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "CustomOSImageUpdateModel": { "properties": { "access_key": { "type": "string" }, "image_href": { "type": "string" }, "login": { "type": "string" }, "os_family_type": { "enum": [ "ubuntu/debian", "windows", "esxi", "other" ], "example": "ubuntu/debian", "type": "string" }, "owner_id": { "type": "integer" }, "secret_key": { "type": "string" }, "storage_type": { "enum": [ "s3", "http", "local" ], "example": "s3", "type": "string" }, "version_name": { "type": "string" } }, "type": "object" }, "Device": { "properties": { "name": { "description": "Boot device name.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "DeviceInfo": { "properties": { "description": { "description": "Boot device description.", "type": "string" }, "name": { "description": "Boot device name.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "DeviceSet": { "properties": { "ip_address_uuid": { "description": "IP address identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "name": { "description": "Boot device name.", "type": "string" }, "password": { "description": "Password for boot device.", "type": "string" }, "reboot": { "description": "If true, reboots the server after setting boot device.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "DiscountDetailModel": { "properties": { "discounts_from_campaigns": { "description": "Auction Discount Campaign details.", "type": "object" }, "price_plan": { "description": "Price plan discount percentage.", "type": "integer" }, "resource": { "description": "Resource discount percentage.", "type": "integer" }, "user": { "description": "User discount percentage.", "type": "integer" } }, "required": [ "discounts_from_campaigns", "price_plan", "resource", "user" ], "type": "object" }, "DriverStatus": { "properties": { "driver_status": { "allOf": [ { "$ref": "#/definitions/PowerStatus" } ], "description": "Driver power status information." } }, "type": "object" }, "EventModel": { "properties": { "action_name": { "description": "Action name.", "type": "string" }, "change_data": { "description": "Data that has been changed.", "type": "object" }, "item_name": { "description": "Item name.", "type": "string" }, "item_uuid": { "description": "Item identifier.", "type": "string" }, "keystone_uid": { "description": "Keystone user identifier.", "type": "string" }, "request_uuid": { "description": "Request identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "secondary_user_id": { "description": "Secondary user identifier.", "type": "string" }, "staff_id": { "description": "Staff identifier.", "type": "integer" }, "user_id": { "description": "User identifier.", "type": "integer" } }, "type": "object" }, "EventResultListModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of events.", "items": { "$ref": "#/definitions/EventModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "FirewallConfig": { "properties": { "interfaces": { "items": { "$ref": "#/definitions/FirewallInterfaces" }, "type": "array" }, "parameters": { "items": { "$ref": "#/definitions/FirewallParameters" }, "type": "array" } }, "type": "object" }, "FirewallExtraContent": { "properties": { "firewall_comment": { "description": "Firewall comment.", "type": "string" }, "firewall_network_uuid": { "description": "Firewall network identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "firewall_subnets": { "description": "List of firewall subnets.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "FirewallInterfaces": { "properties": { "name": { "enum": [ "rj45", "sfp", "sfp+" ], "example": "rj45", "type": "string" }, "speed": { "maximum": 99, "minimum": 0, "type": "integer" } }, "required": [ "name", "speed" ], "type": "object" }, "FirewallParameters": { "properties": { "name": { "enum": [ "fw", "ips", "vpn", "ssl-vpn" ], "example": "fw", "type": "string" }, "speed": { "maximum": 100, "minimum": 0, "type": "number" } }, "required": [ "name", "speed" ], "type": "object" }, "FirewallViewModel": { "allOf": [ { "$ref": "#/definitions/ServiceView" }, { "$ref": "#/definitions/ServiceBase" }, { "properties": { "addition": { "description": "List of additional services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "available": { "description": "List of available configurations per location.", "items": { "$ref": "#/definitions/ServiceAvailable" }, "type": "array" }, "config": { "allOf": [ { "$ref": "#/definitions/FirewallConfig" } ], "description": "Firewall configuration." }, "eol_date": { "description": "End-of-life date as a Unix timestamp.", "type": "integer" }, "is_editable": { "description": "Indicates whether the service configuration is editable.", "type": "boolean" }, "is_order": { "description": "Indicates whether the service is available for ordering.", "type": "boolean" }, "is_preorder": { "description": "Indicates whether the service is available for pre-ordering.", "type": "boolean" }, "is_price_plan_discount_enabled": { "description": "Indicates whether the price plan discount is enabled.", "type": "boolean" }, "is_primary": { "description": "Indicates whether the service is primary.", "type": "boolean" }, "is_qchange": { "description": "Indicates whether the service supports quick change.", "type": "boolean" }, "is_single_prolonged": { "description": "Indicates whether the service has a single renewal period.", "type": "boolean" }, "is_user_discount_enabled": { "description": "Indicates whether the user discount is enabled.", "type": "boolean" }, "location_price_collection": { "allOf": [ { "$ref": "#/definitions/LocationPriceModelView" } ], "description": "Price collection per location." }, "model": { "description": "Service model type.", "type": "string" }, "name": { "description": "Name of the service.", "type": "string" }, "price_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Price collection for the service." }, "price_plan_available": { "description": "List of available price plan UUIDs.", "items": { "type": "string" }, "type": "array" }, "primary": { "description": "List of primary services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "quantity": { "description": "Quantity of service units.", "type": "integer" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "setup_fee_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Setup fee price collection." }, "state": { "description": "Billing state of the service.", "type": "string" }, "tag_list": { "description": "List of tag objects assigned to the service.", "items": { "$ref": "#/definitions/ServiceTagCatalog" }, "type": "array" }, "tags": { "description": "List of tag names assigned to the service.", "items": { "type": "string" }, "type": "array" }, "tariff_line": { "description": "Billing option of the service.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "addition", "available", "is_order", "is_preorder", "is_price_plan_discount_enabled", "is_primary", "is_single_prolonged", "is_user_discount_enabled", "model", "name", "price_collection", "price_plan_available", "primary", "service_tag", "setup_fee_collection", "state", "tag_list", "tags", "tariff_line", "uuid" ], "type": "object" } ] }, "HardmathConfigItemFeatureModel": { "properties": { "link": { "type": "string" }, "uuid": { "type": "string" } }, "type": "object" }, "HealthInfo": { "properties": { "environment": { "description": "Environment name.", "type": "string" }, "version_api": { "description": "API version.", "type": "string" } }, "type": "object" }, "HealthInfoResponse": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/HealthInfo" } ], "description": "API health information." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "IPv4Input": { "properties": { "ipv4_address": { "description": "IPv4 address.", "example": "10.0.0.0", "maxLength": 43, "minLength": 6, "type": "string" }, "ipv4_gateway": { "description": "IPv4 gateway address.", "example": "10.0.0.0", "maxLength": 43, "minLength": 6, "type": "string" }, "ipv4_netmask": { "description": "IPv4 network mask.", "example": "255.255.255.248", "maxLength": 43, "minLength": 6, "type": "string" }, "local_ipv4_address": { "description": "Local IPv4 address.", "example": "10.0.0.0", "maxLength": 43, "minLength": 6, "type": "string" }, "local_ipv4_gateway": { "description": "Local IPv4 gateway address.", "example": "10.0.0.0", "maxLength": 43, "minLength": 6, "type": "string" }, "local_ipv4_netmask": { "description": "Local IPv4 network mask.", "example": "255.255.255.248", "maxLength": 43, "minLength": 6, "type": "string" } }, "type": "object" }, "IPv6Input": { "properties": { "ipv6_address": { "description": "IPv6 address.", "example": "fec0::0001", "maxLength": 43, "minLength": 6, "type": "string" }, "ipv6_gateway": { "description": "IPv6 gateway address.", "example": "fec0::0001", "maxLength": 43, "minLength": 6, "type": "string" }, "ipv6_netmask": { "description": "IPv6 network mask.", "example": "ffff:ffff:ffff::", "maxLength": 43, "minLength": 6, "type": "string" }, "local_ipv6_address": { "description": "Local IPv6 address.", "example": "fec0::0001", "maxLength": 43, "minLength": 6, "type": "string" }, "local_ipv6_gateway": { "description": "Local IPv6 gateway address.", "example": "fec0::0001", "maxLength": 43, "minLength": 6, "type": "string" }, "local_ipv6_netmask": { "description": "Local IPv6 network mask.", "example": "ffff:ffff:ffff::", "maxLength": 43, "minLength": 6, "type": "string" } }, "type": "object" }, "IpAllocateModel": { "properties": { "ip": { "description": "Specific IP address to allocate. If not specified, the next available IP will be allocated.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "resource_uuid": { "description": "Resource identifier to allocate the IP address to.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "resource_uuid" ], "type": "object" }, "IpModel": { "properties": { "broadcast": { "description": "Broadcast address.", "type": "string" }, "created": { "description": "Creation timestamp.", "type": "integer" }, "gateway": { "description": "Gateway address.", "type": "string" }, "ip": { "description": "IP address.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "netmask": { "description": "Network mask.", "type": "string" }, "network": { "description": "Network tag or VLAN number.", "type": "string" }, "network_uuid": { "description": "Network identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "resource_uuid": { "description": "Resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "subnet": { "description": "Subnet in CIDR notation.", "example": "10.0.0.0/29", "maxLength": 43, "minLength": 8, "type": "string" }, "subnet_type": { "description": "Type of the subnet.", "enum": [ "normal", "static", "vrrp", "alias" ], "example": "normal", "type": "string" }, "subnet_uuid": { "description": "Subnet identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "updated": { "description": "Last update timestamp.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "version": { "description": "IP version (4 or 6).", "type": "integer" } }, "required": [ "broadcast", "created", "gateway", "ip", "netmask", "subnet", "subnet_uuid", "updated", "uuid" ], "type": "object" }, "IpModelList": { "properties": { "broadcast": { "description": "Broadcast address.", "type": "string" }, "created": { "description": "Creation timestamp.", "type": "integer" }, "gateway": { "description": "Gateway address.", "type": "string" }, "ip": { "description": "IP address.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "netmask": { "description": "Network mask.", "type": "string" }, "network": { "description": "Network tag or VLAN number.", "type": "string" }, "network_uuid": { "description": "Network identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "project_uuid": { "description": "Project identifier.", "type": "string" }, "resource_uuid": { "description": "Resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "subnet": { "description": "Subnet in CIDR notation.", "example": "10.0.0.0/29", "maxLength": 43, "minLength": 8, "type": "string" }, "subnet_type": { "description": "Type of the subnet.", "enum": [ "normal", "static", "vrrp", "alias" ], "example": "normal", "type": "string" }, "subnet_uuid": { "description": "Subnet identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "updated": { "description": "Last update timestamp.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "version": { "description": "IP version (4 or 6).", "type": "integer" } }, "required": [ "broadcast", "created", "gateway", "ip", "netmask", "project_uuid", "subnet", "subnet_uuid", "updated", "uuid" ], "type": "object" }, "IpReleaseModel": { "properties": { "resource_uuid": { "description": "Resource identifier to release the IP address from.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "resource_uuid" ], "type": "object" }, "IpResultListModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of IP addresses.", "items": { "$ref": "#/definitions/IpModelList" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "IpResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/IpModel" } ], "description": "IP address object." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "LocalIpAllocateModel": { "properties": { "comment": { "description": "Optional comment.", "type": "string" }, "ip": { "description": "Specific local IP address to allocate. If not specified, the next available IP will be allocated.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "resource_uuid": { "description": "Resource identifier to allocate the local IP address to.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "type": "object" }, "LocalIpModel": { "properties": { "broadcast": { "description": "Broadcast address.", "type": "string" }, "comment": { "description": "Optional comment.", "type": "string" }, "created": { "description": "Creation timestamp.", "type": "integer" }, "gateway": { "description": "Gateway address.", "type": "string" }, "ip": { "description": "Local IP address.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "is_reserved": { "description": "If true, the IP is reserved.", "type": "boolean" }, "netmask": { "description": "Network mask.", "type": "string" }, "network": { "description": "Network tag or VLAN number.", "type": "string" }, "network_uuid": { "description": "Network identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "owner_id": { "description": "Owner identifier.", "type": "integer" }, "resource_uuid": { "description": "Resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "service_tag": { "description": "Service tag type.", "enum": [ "global_router_vrrp", "global_router_gateway", "mks_vrrp", "mks_gateway", "blockstorage_san_via_lan" ], "example": "global_router_vrrp", "type": "string" }, "subnet": { "description": "Subnet in CIDR notation.", "example": "10.0.0.0/29", "maxLength": 43, "minLength": 8, "type": "string" }, "subnet_uuid": { "description": "Subnet identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "updated": { "description": "Last update timestamp.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "version": { "description": "IP version (4 or 6).", "type": "integer" } }, "required": [ "broadcast", "created", "gateway", "ip", "netmask", "subnet", "subnet_uuid", "updated", "uuid" ], "type": "object" }, "LocalIpReleaseModel": { "properties": { "resource_uuid": { "description": "Resource identifier to release the local IP address from.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "resource_uuid" ], "type": "object" }, "LocalIpResultListModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "project_uuid": { "description": "Project identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "result": { "description": "List of local IP addresses.", "items": { "$ref": "#/definitions/LocalIpModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "LocalIpResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/LocalIpModel" } ], "description": "Local IP address object." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "LocalSubnetCreateModel": { "properties": { "network_uuid": { "description": "Network identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "owner_id": { "description": "Owner identifier.", "type": "integer" }, "subnet_address": { "description": "IPv4 subnet address in CIDR notation.", "example": "10.0.0.0/29", "maxLength": 18, "minLength": 9, "type": "string" } }, "required": [ "network_uuid", "subnet_address" ], "type": "object" }, "LocalSubnetDetailModel": { "properties": { "broadcast": { "description": "Broadcast address.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "created": { "description": "Creation timestamp.", "type": "integer" }, "global_router_uuid": { "description": "Global router identifier.", "type": "string" }, "location_uuid": { "description": "Location identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "netmask": { "description": "Network mask.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "network": { "description": "Network identifier.", "type": "integer" }, "network_uuid": { "description": "Network identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "owner_id": { "description": "Owner identifier.", "type": "integer" }, "service_tags": { "description": "List of service tags.", "items": { "type": "string" }, "type": "array" }, "subnet": { "description": "Local subnet in CIDR notation.", "example": "10.0.0.0/29", "maxLength": 43, "minLength": 8, "type": "string" }, "updated": { "description": "Last update timestamp.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "created", "location_uuid", "network", "network_uuid", "owner_id", "subnet", "updated", "uuid" ], "type": "object" }, "LocalSubnetDetailResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/LocalSubnetDetailModel" } ], "description": "Local subnet object." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "LocalSubnetRemoveModel": { "properties": {}, "type": "object" }, "LocationModel": { "properties": { "dc_count": { "type": "integer" }, "description": { "maxLength": 128, "type": "string" }, "location_id": { "type": "integer" }, "name": { "maxLength": 64, "type": "string" }, "primary_resource_ordering": { "enum": [ "enabled", "enabled_in_admin", "disabled" ], "example": "enabled", "type": "string" }, "uuid": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "visibility": { "enum": [ "everywhere", "only_in_admin" ], "example": "everywhere", "type": "string" } }, "required": [ "location_id", "name", "primary_resource_ordering", "uuid", "visibility" ], "type": "object" }, "LocationPriceModelView": { "properties": { "*": { "additionalProperties": { "$ref": "#/definitions/PriceModel" }, "type": "object" } }, "type": "object" }, "LocationResultListModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/LocationModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "LocationResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/LocationModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "MaintenanceStatus": { "properties": { "status": { "description": "Indicates whether maintenance is currently active.", "type": "boolean" } }, "required": [ "status" ], "type": "object" }, "MaintenanceStatusResponse": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/MaintenanceStatus" } ], "description": "Maintenance status data." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "NameBase": { "properties": { "description": { "description": "Description of the name.", "type": "string" }, "name": { "description": "Name value.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "name", "uuid" ], "type": "object" }, "NetworkAddSubnetModel": { "properties": { "subnet_uuid": { "description": "Subnet identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "subnet_uuid" ], "type": "object" }, "NetworkBasicFirewallAddModel": { "properties": { "name": { "description": "Firewall configuration name.", "maxLength": 255, "type": "string" }, "rules": { "description": "List of firewall rules to apply.", "items": { "$ref": "#/definitions/RuleModel" }, "type": "array" } }, "required": [ "rules" ], "type": "object" }, "NetworkBasicFirewallModel": { "properties": { "applied_rules": { "description": "List of currently applied firewall rules.", "items": { "$ref": "#/definitions/RuleModel" }, "type": "array" }, "created": { "description": "Creation timestamp.", "type": "integer" }, "name": { "description": "Firewall configuration name.", "maxLength": 255, "type": "string" }, "network_uuid": { "description": "Network identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "new_rules": { "description": "List of new firewall rules pending application.", "items": { "$ref": "#/definitions/RuleModel" }, "type": "array" }, "state": { "description": "Current state of the firewall configuration.", "enum": [ "pending", "processing", "applied", "inactive", "cleaning", "error" ], "example": "pending", "type": "string" }, "updated": { "description": "Last update timestamp.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "applied_rules", "name", "network_uuid", "state", "uuid" ], "type": "object" }, "NetworkBasicFirewallResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/NetworkBasicFirewallModel" } ], "description": "Network basic firewall configuration object." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "NetworkEquipmentViewModel": { "allOf": [ { "$ref": "#/definitions/ServiceView" }, { "properties": { "addition": { "description": "List of additional services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "available": { "description": "List of available configurations per location.", "items": { "$ref": "#/definitions/ServiceAvailable" }, "type": "array" }, "eol_date": { "description": "End-of-life date as a Unix timestamp.", "type": "integer" }, "is_editable": { "description": "Indicates whether the service configuration is editable.", "type": "boolean" }, "is_order": { "description": "Indicates whether the service is available for ordering.", "type": "boolean" }, "is_preorder": { "description": "Indicates whether the service is available for pre-ordering.", "type": "boolean" }, "is_price_plan_discount_enabled": { "description": "Indicates whether the price plan discount is enabled.", "type": "boolean" }, "is_primary": { "description": "Indicates whether the service is primary.", "type": "boolean" }, "is_qchange": { "description": "Indicates whether the service supports quick change.", "type": "boolean" }, "is_single_prolonged": { "description": "Indicates whether the service has a single renewal period.", "type": "boolean" }, "is_user_discount_enabled": { "description": "Indicates whether the user discount is enabled.", "type": "boolean" }, "location_price_collection": { "allOf": [ { "$ref": "#/definitions/LocationPriceModelView" } ], "description": "Price collection per location." }, "model": { "description": "Service model type.", "type": "string" }, "name": { "description": "Name of the service.", "type": "string" }, "price_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Price collection for the service." }, "price_plan_available": { "description": "List of available price plan UUIDs.", "items": { "type": "string" }, "type": "array" }, "primary": { "description": "List of primary services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "quantity": { "description": "Quantity of service units.", "type": "integer" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "setup_fee_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Setup fee price collection." }, "state": { "description": "Billing state of the service.", "type": "string" }, "tag_list": { "description": "List of tag objects assigned to the service.", "items": { "$ref": "#/definitions/ServiceTagCatalog" }, "type": "array" }, "tags": { "description": "List of tag names assigned to the service.", "items": { "type": "string" }, "type": "array" }, "tariff_line": { "description": "Billing option of the service.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "addition", "available", "is_order", "is_preorder", "is_price_plan_discount_enabled", "is_primary", "is_single_prolonged", "is_user_discount_enabled", "model", "name", "price_collection", "price_plan_available", "primary", "service_tag", "setup_fee_collection", "state", "tag_list", "tags", "tariff_line", "uuid" ], "type": "object" } ] }, "NetworkLimitModel": { "properties": { "created": { "description": "Creation timestamp.", "type": "integer" }, "current_limit_type": { "description": "Currently active network limit type.", "type": "string" }, "enable": { "description": "If true, network limit is enabled.", "type": "boolean" }, "limit": { "description": "Network bandwidth limit value in Mbps.", "type": "integer" }, "limit_last_switch": { "description": "Timestamp of the last limit type switch.", "type": "integer" }, "next_limit_type": { "description": "Requested network limit type that will be applied asynchronously.", "type": "string" }, "updated": { "description": "Last update timestamp.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "created", "enable", "limit", "updated", "uuid" ], "type": "object" }, "NetworkLimitResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/NetworkLimitModel" } ], "description": "Network limit object." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "NetworkLimitTypeModel": { "properties": { "description": { "description": "Network limit type description.", "type": "string" }, "name": { "description": "Network limit type name.", "type": "string" } }, "required": [ "description", "name" ], "type": "object" }, "NetworkLimitTypeResultListModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of available network limit types.", "items": { "$ref": "#/definitions/NetworkLimitTypeModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "NetworkLimitUpdateModel": { "properties": { "next_limit_type": { "description": "Network limit type to be applied asynchronously.", "type": "string" } }, "type": "object" }, "NetworkListResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of networks.", "items": { "$ref": "#/definitions/NetworkModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "NetworkModel": { "properties": { "created": { "description": "Creation timestamp.", "type": "integer" }, "dhcp_flag": { "description": "DHCP configuration flag.", "type": "string" }, "is_processing": { "description": "If true, network is currently being processed.", "type": "boolean" }, "is_shared": { "description": "If true, network is shared between clients, otherwise it is a dedicated client network.", "type": "boolean" }, "l2_vpn_flag": { "description": "Layer 2 VPN configuration flag.", "type": "string" }, "l3_vpn_flag": { "description": "Layer 3 VPN configuration flag.", "type": "string" }, "location_uuid": { "description": "Location identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "network_assigment_type": { "description": "Network assignment type.", "enum": [ "access", "trunk" ], "example": "access", "type": "string" }, "network_type": { "description": "Type of the network.", "enum": [ "local", "inet" ], "example": "local", "type": "string" }, "owner_id": { "description": "Owner identifier.", "type": "integer" }, "project_uuid": { "description": "Project identifier.", "type": "string" }, "subnet_count": { "description": "Number of subnets in the network.", "type": "integer" }, "tag": { "description": "Network tag, which may include a VLAN identifier.", "type": "string" }, "telematics_type": { "description": "Telematics type if applicable.", "type": [ "string", "null" ] }, "updated": { "description": "Last update timestamp.", "type": "integer" }, "user_desc": { "description": "User-defined network description.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "vlan": { "description": "VLAN identifier. DEPRECATED: use \"tag\" instead.", "type": "integer" } }, "required": [ "created", "dhcp_flag", "is_processing", "is_shared", "l2_vpn_flag", "l3_vpn_flag", "location_uuid", "network_type", "owner_id", "subnet_count", "updated", "uuid" ], "type": "object" }, "NetworkModelSingle": { "properties": { "created": { "description": "Creation timestamp.", "type": "integer" }, "dhcp_flag": { "description": "DHCP configuration flag.", "type": "string" }, "is_processing": { "description": "If true, network is currently being processed.", "type": "boolean" }, "is_shared": { "description": "If true, network is shared between clients, otherwise it is a dedicated client network.", "type": "boolean" }, "l2_vpn_flag": { "description": "Layer 2 VPN configuration flag.", "type": "string" }, "l3_vpn_flag": { "description": "Layer 3 VPN configuration flag.", "type": "string" }, "location_uuid": { "description": "Location identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "network_assigment_type": { "description": "Network assignment type.", "enum": [ "access", "trunk" ], "example": "access", "type": "string" }, "network_type": { "description": "Type of the network.", "enum": [ "local", "inet" ], "example": "local", "type": "string" }, "owner_id": { "description": "Owner identifier.", "type": "integer" }, "project_uuid": { "description": "Project identifier.", "type": "string" }, "qinq": { "description": "If true, QinQ (802.1ad) is enabled.", "type": [ "boolean", "null" ] }, "subnet": { "description": "List of subnets in the network.", "items": { "$ref": "#/definitions/NetworkSubnetSmallModel" }, "type": "array" }, "subnet_count": { "description": "Number of subnets in the network.", "type": "integer" }, "tag": { "description": "Network tag, which may include a VLAN identifier.", "type": "string" }, "telematics_type": { "description": "Telematics type if applicable.", "type": [ "string", "null" ] }, "updated": { "description": "Last update timestamp.", "type": "integer" }, "user_desc": { "description": "User-defined network description.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "vlan": { "description": "VLAN identifier. DEPRECATED: use \"tag\" instead.", "type": "integer" } }, "required": [ "created", "dhcp_flag", "is_processing", "is_shared", "l2_vpn_flag", "l3_vpn_flag", "location_uuid", "network_type", "owner_id", "qinq", "subnet_count", "updated", "uuid" ], "type": "object" }, "NetworkReleaseSubnetModel": { "properties": { "subnet_uuid": { "description": "Subnet identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "subnet_uuid" ], "type": "object" }, "NetworkResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/NetworkModelSingle" } ], "description": "Network object." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "NetworkSubnetSmallModel": { "properties": { "is_full": { "description": "If true, subnet has no available IP addresses.", "type": "boolean" }, "subnet": { "description": "Subnet in CIDR notation.", "example": "10.0.0.0/29", "maxLength": 43, "minLength": 8, "type": "string" }, "usage": { "description": "Subnet usage percentage.", "type": "number" }, "used": { "description": "Number of used IP addresses in the subnet.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "is_full", "subnet", "uuid" ], "type": "object" }, "NetworkUpdateModel": { "properties": { "user_desc": { "description": "User-defined network description.", "type": "string" } }, "type": "object" }, "NetworkViewModel": { "allOf": [ { "$ref": "#/definitions/ServiceView" }, { "properties": { "addition": { "description": "List of additional services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "available": { "description": "List of available configurations per location.", "items": { "$ref": "#/definitions/ServiceAvailable" }, "type": "array" }, "eol_date": { "description": "End-of-life date as a Unix timestamp.", "type": "integer" }, "is_editable": { "description": "Indicates whether the service configuration is editable.", "type": "boolean" }, "is_order": { "description": "Indicates whether the service is available for ordering.", "type": "boolean" }, "is_preorder": { "description": "Indicates whether the service is available for pre-ordering.", "type": "boolean" }, "is_price_plan_discount_enabled": { "description": "Indicates whether the price plan discount is enabled.", "type": "boolean" }, "is_primary": { "description": "Indicates whether the service is primary.", "type": "boolean" }, "is_qchange": { "description": "Indicates whether the service supports quick change.", "type": "boolean" }, "is_single_prolonged": { "description": "Indicates whether the service has a single renewal period.", "type": "boolean" }, "is_user_discount_enabled": { "description": "Indicates whether the user discount is enabled.", "type": "boolean" }, "location_price_collection": { "allOf": [ { "$ref": "#/definitions/LocationPriceModelView" } ], "description": "Price collection per location." }, "model": { "description": "Service model type.", "type": "string" }, "name": { "description": "Name of the service.", "type": "string" }, "price_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Price collection for the service." }, "price_plan_available": { "description": "List of available price plan UUIDs.", "items": { "type": "string" }, "type": "array" }, "primary": { "description": "List of primary services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "quantity": { "description": "Quantity of service units.", "type": "integer" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "setup_fee_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Setup fee price collection." }, "state": { "description": "Billing state of the service.", "type": "string" }, "tag_list": { "description": "List of tag objects assigned to the service.", "items": { "$ref": "#/definitions/ServiceTagCatalog" }, "type": "array" }, "tags": { "description": "List of tag names assigned to the service.", "items": { "type": "string" }, "type": "array" }, "tariff_line": { "description": "Billing option of the service.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "addition", "available", "is_order", "is_preorder", "is_price_plan_discount_enabled", "is_primary", "is_single_prolonged", "is_user_discount_enabled", "model", "name", "price_collection", "price_plan_available", "primary", "service_tag", "setup_fee_collection", "state", "tag_list", "tags", "tariff_line", "uuid" ], "type": "object" } ] }, "NextPriceModel": { "properties": { "amount_due": { "description": "Amount due for payment.", "type": "number" }, "debt": { "description": "Current debt amount.", "type": "number" }, "discount": { "description": "Total discount percentage.", "maximum": 99, "minimum": 0, "type": "integer" }, "discount_detail": { "allOf": [ { "$ref": "#/definitions/DiscountDetailModel" } ], "description": "Detailed discount breakdown." }, "due_date": { "description": "Timestamp of the end of the current billing period.", "type": "integer" }, "future_price": { "description": "Resource price with discount applied for the entire duration of the next price plan (same as plan_price if current and next plans are identical).", "type": "number" }, "paid_till": { "description": "Timestamp until which the resource was paid for.", "type": "integer" }, "plan_price": { "description": "Resource price with discount applied for the entire duration of the current price plan.", "type": "number" }, "setup_fee": { "description": "Setup fee amount.", "type": "integer" } }, "required": [ "amount_due", "debt", "discount", "discount_detail", "future_price", "plan_price", "setup_fee" ], "type": "object" }, "OSConfig": { "allOf": [ { "$ref": "#/definitions/BaseOSConfig" }, { "$ref": "#/definitions/PartitionsOSConfig" }, { "$ref": "#/definitions/ReinstallInput" }, { "properties": { "arch": { "description": "Operating system architecture.", "example": "x86_64", "type": "string" }, "cloud_init_meta_data": { "description": "Cloud-init metadata configuration.", "type": [ "string", "null" ] }, "cloud_init_user_data": { "description": "Cloud-init user data configuration.", "type": [ "string", "null" ] }, "ipv4_address": { "description": "IPv4 address.", "example": "10.0.0.0", "maxLength": 43, "minLength": 6, "type": "string" }, "ipv4_gateway": { "description": "IPv4 gateway address.", "example": "10.0.0.0", "maxLength": 43, "minLength": 6, "type": "string" }, "ipv4_netmask": { "description": "IPv4 network mask.", "example": "255.255.255.248", "maxLength": 43, "minLength": 6, "type": "string" }, "ipv6_address": { "description": "IPv6 address.", "example": "fec0::0001", "maxLength": 43, "minLength": 6, "type": "string" }, "ipv6_gateway": { "description": "IPv6 gateway address.", "example": "fec0::0001", "maxLength": 43, "minLength": 6, "type": "string" }, "ipv6_netmask": { "description": "IPv6 network mask.", "example": "ffff:ffff:ffff::", "maxLength": 43, "minLength": 6, "type": "string" }, "is_password_deleted": { "description": "Indicates whether the password has been deleted.", "type": [ "boolean", "null" ] }, "is_processing": { "description": "Indicates whether the operating system installation is in progress.", "type": "boolean" }, "local_ipv4_address": { "description": "Local IPv4 address.", "example": "10.0.0.0", "maxLength": 43, "minLength": 6, "type": "string" }, "local_ipv4_gateway": { "description": "Local IPv4 gateway address.", "example": "10.0.0.0", "maxLength": 43, "minLength": 6, "type": "string" }, "local_ipv4_netmask": { "description": "Local IPv4 network mask.", "example": "255.255.255.248", "maxLength": 43, "minLength": 6, "type": "string" }, "local_ipv6_address": { "description": "Local IPv6 address.", "example": "fec0::0001", "maxLength": 43, "minLength": 6, "type": "string" }, "local_ipv6_gateway": { "description": "Local IPv6 gateway address.", "example": "fec0::0001", "maxLength": 43, "minLength": 6, "type": "string" }, "local_ipv6_netmask": { "description": "Local IPv6 network mask.", "example": "ffff:ffff:ffff::", "maxLength": 43, "minLength": 6, "type": "string" }, "login": { "description": "Default operating system login.", "type": "string" }, "os_template": { "description": "Operating system template name.", "example": "ubuntu", "type": "string" }, "partitions": { "description": "List of partitions. Template version v1 only.", "items": { "$ref": "#/definitions/PartitionUpdateModel" }, "type": "array" }, "partitions_config": { "allOf": [ { "$ref": "#/definitions/PartitionsConfigModel" } ], "description": "Full partitions configuration. Template version v2 only.", "example": { "b80a3a31-1ce1-531a-a271-78a33f9dddce": { "match": { "size": 2000, "type": "SATA HDD" }, "type": "local_drive" }, "root": { "device": "you_name_it_3", "fstype": "ext4", "mount": "/", "type": "filesystem" }, "you_name_it": { "device": "b80a3a31-1ce1-531a-a271-78a33f9dddce", "size": 999, "type": "partition" }, "you_name_it_2": { "device": "b80a3a31-1ce1-531a-a271-78a33f9dddce", "size": 999, "type": "partition" }, "you_name_it_3": { "level": "raid1", "members": [ "you_name_it", "you_name_it_2" ], "type": "soft_raid" } } }, "password": { "description": "Operating system password.", "type": [ "string", "null" ] }, "password_last_action": { "description": "Last password action timestamp.", "type": "string" }, "raid_type": { "description": "Configuration type of disks. Template version v1 only.", "example": "noraid", "type": "string" }, "reinstall": { "description": "Reinstall flag value.", "type": "integer" }, "template_version": { "description": "Operating system template version.", "example": "v1", "type": "string" }, "user_script": { "description": "Custom user installation script.", "type": [ "string", "null" ] }, "user_ssh_key": { "description": "User SSH public key.", "type": "string" }, "userhostname": { "description": "User hostname.", "type": "string" }, "version": { "description": "Operating system version.", "example": "16.04", "type": "string" } }, "required": [ "arch", "os_template", "password", "userhostname", "version" ], "type": "object" } ] }, "OSConfigCreateInput": { "allOf": [ { "$ref": "#/definitions/BaseOSConfig" }, { "$ref": "#/definitions/PartitionsOSConfig" }, { "properties": { "password": { "description": "Password for operating system. Auto-generated if the field doesn't exist.", "type": "string" } }, "type": "object" } ] }, "OSConfigInput": { "allOf": [ { "$ref": "#/definitions/BaseOSConfig" }, { "$ref": "#/definitions/PartitionsOSConfig" }, { "properties": { "password": { "description": "Password for operating system.", "type": "string" }, "reset_local_address": { "description": "If true, resets the local address.", "type": "boolean" } }, "type": "object" } ] }, "OSTemplate": { "properties": { "allowed_fs_types": { "description": "List of allowed filesystem types.", "items": { "type": "string" }, "type": "array" }, "arch": { "description": "List of supported architectures.", "items": { "type": "string" }, "type": "array" }, "default_partitions": { "description": "List of default partitions.", "items": { "$ref": "#/definitions/PartitionModel" }, "type": "array" }, "login": { "description": "Default operating system login.", "type": "string" }, "name": { "description": "Operating system template name.", "type": "string" }, "partitioning": { "description": "Indicates whether custom partitioning is supported.", "type": "boolean" }, "raid": { "description": "List of available RAID configurations.", "items": { "$ref": "#/definitions/RaidModel" }, "type": "array" }, "value": { "description": "Operating system template value.", "type": "string" }, "versions": { "description": "List of available operating system versions.", "items": { "$ref": "#/definitions/OSVersion" }, "type": "array" } }, "type": "object" }, "OSTemplateDetailModel": { "properties": { "allowed_fs_types": { "description": "List of allowed filesystem types.", "items": { "type": "string" }, "type": "array" }, "app_name": { "description": "Application name.", "type": "string" }, "app_version": { "description": "Application version.", "type": "string" }, "arch": { "description": "Operating system architecture.", "enum": [ "x86_64", "i386", "aarch64", "aarch64_pi4", "aarch64_m1" ], "example": "x86_64", "type": "string" }, "default_partitions": { "description": "List of default partitions.", "items": { "$ref": "#/definitions/PartitionModel" }, "type": "array" }, "default_script": { "description": "Default installation script.", "type": "string" }, "excluded_locations": { "description": "List of excluded location identifiers.", "items": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "type": "array" }, "excluded_services": { "description": "List of excluded service identifiers.", "items": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "type": "array" }, "image_url": { "description": "Operating system image URL.", "type": [ "string", "null" ] }, "install_script": { "description": "Installation script.", "type": "string" }, "is_ssh_key_allowed": { "description": "Indicates whether SSH keys are allowed.", "type": "boolean" }, "login": { "description": "Default operating system login.", "type": "string" }, "os_name": { "description": "Operating system name.", "enum": [ "Debian", "Ubuntu", "CentOS", "Oracle", "AstraLinux", "AlmaLinux", "Rocky", "SelectOS", "Proxmox", "Opensuse", "VMware ESXi", "Windows Server", "FreeBSD", "Mac OS", "Raspberry Pi OS", "Managed k8s", "Pre-installed Apps", "Custom OS", "No OS - erase all disks", "No OS - boot" ], "example": "Debian", "type": "string" }, "os_value": { "description": "Operating system value.", "enum": [ "debian", "ubuntu", "centos", "oracle", "astralinux", "almalinux", "rocky", "selectos", "proxmox", "opensuse", "esxi", "windows", "freebsd", "macos", "rpios", "mks", "preinstall", "custom", "erase", "noos" ], "example": "debian", "type": "string" }, "outdated": { "description": "Indicates whether the template is outdated.", "type": "boolean" }, "owner_id": { "description": "Owner identifier.", "type": "integer" }, "partitioning": { "description": "Indicates whether custom partitioning is supported.", "type": "boolean" }, "raid": { "description": "List of available RAID configurations.", "items": { "$ref": "#/definitions/RaidModel" }, "type": "array" }, "script_allowed": { "description": "Indicates whether custom scripts are allowed.", "type": "boolean" }, "template_version": { "description": "Operating system template version.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "version_name": { "description": "Operating system version name.", "type": "string" }, "version_value": { "description": "Operating system version value.", "type": "string" } }, "type": "object" }, "OSTemplateListNewResponse": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of operating system templates.", "items": { "$ref": "#/definitions/OSTemplateDetailModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "OSVersion": { "properties": { "default_script": { "description": "Default installation script.", "type": "string" }, "name": { "description": "Operating system version name.", "type": "string" }, "outdated": { "description": "Indicates whether the operating system version is outdated.", "type": "boolean" }, "script_allowed": { "description": "Indicates whether custom scripts are allowed.", "type": "boolean" }, "value": { "description": "Operating system version value.", "type": "string" }, "visible": { "description": "Indicates whether the operating system version is visible.", "type": "boolean" } }, "type": "object" }, "PartitionModel": { "properties": { "editable": { "description": "Indicates whether the partition can be edited.", "type": "boolean" }, "expand": { "description": "Indicates whether the partition can be expanded.", "type": "boolean" }, "fstype": { "description": "Filesystem type.", "type": "string" }, "mount": { "description": "Mount point.", "type": "string" }, "size": { "description": "Partition size in megabytes.", "type": "integer" } }, "required": [ "editable", "expand", "fstype", "mount", "size" ], "type": "object" }, "PartitionUpdateModel": { "properties": { "expand": { "description": "Indicates whether the partition can be expanded.", "type": "boolean" }, "fstype": { "description": "Filesystem type.", "type": "string" }, "mount": { "description": "Mount point.", "type": "string" }, "size": { "description": "Partition size in megabytes.", "type": "integer" } }, "type": "object" }, "PartitionsConfigModel": { "properties": { "*": { "additionalProperties": { "allOf": [ { "$ref": "#/definitions/PartitionsConfigNodeModel" } ], "description": "List of disks, partitions, raids, and other storage elements." }, "type": "object" } }, "type": "object" }, "PartitionsConfigNodeMatch": { "properties": { "controller_port": { "description": "Internal controller sequence number of the port.", "example": 0, "minimum": 0, "type": "integer" }, "size": { "description": "Minimum size in gigabytes.", "type": "integer" }, "type": { "description": "Storage device type.", "type": "string" } }, "required": [ "size", "type" ], "type": "object" }, "PartitionsConfigNodeModel": { "properties": { "device": { "description": "Parent device.", "example": "a", "type": "string" }, "fstype": { "description": "Filesystem type.", "example": "ext4", "type": "string" }, "label": { "description": "Label of the file system. Filesystem type only.", "example": "root", "type": "string" }, "level": { "description": "Raid level. Soft_raid type only.", "enum": [ "raid0", "raid1", "raid10", "raid5", "raid6" ], "example": "raid1", "type": "string" }, "match": { "allOf": [ { "$ref": "#/definitions/PartitionsConfigNodeMatch" } ], "description": "Conditions for a local drive. Local_drive type only." }, "members": { "description": "List of parent devices. Soft_raid type only.", "example": [ "a", "b" ], "items": { "type": "string" }, "type": "array" }, "mode": { "description": "Controller's disk mode.", "enum": [ "raid", "hba" ], "example": "raid", "type": "string" }, "mount": { "description": "Mount point. Filesystem type only.", "example": "/", "type": "string" }, "name": { "description": "Name of controller device.", "example": "8 port RAID controller", "type": "string" }, "placement": { "description": "The sequence number of the controller when using multiple boards.", "example": 0, "minimum": 0, "type": "integer" }, "port_count": { "description": "Port count for controllers.", "example": 8, "minimum": 0, "type": "integer" }, "priority": { "description": "Priority of partitions. Higher priority means closer to the beginning of the disk.", "example": 0, "type": "integer" }, "size": { "description": "Size. Partition type only.", "example": -1, "type": "number" }, "type": { "description": "Type of the block device.", "example": "local_drive", "type": "string" }, "vendor": { "description": "LSI or Adaptec controller vendor when using different boards.", "enum": [ "lsi", "adaptec" ], "example": "lsi", "type": "string" } }, "required": [ "type" ], "type": "object" }, "PartitionsCustomConfiguration": { "properties": { "disk": { "description": "List of disks.", "items": { "$ref": "#/definitions/PartitionsCustomDisk" }, "type": "array" }, "pcie": { "description": "List of PCIe devices.", "items": { "$ref": "#/definitions/PartitionsCustomPcie" }, "type": "array" }, "version": { "description": "Version of hardware configuration.", "example": "1.2", "type": "string" } }, "type": "object" }, "PartitionsCustomDisk": { "properties": { "count": { "description": "Number of hardware components.", "type": "integer" }, "feature": { "allOf": [ { "$ref": "#/definitions/PartitionsCustomFeature" } ], "description": "Disk feature information." }, "id": { "description": "Hardware component identifier.", "type": "integer" }, "name": { "description": "Hardware component name.", "type": "string" }, "param": { "allOf": [ { "$ref": "#/definitions/PartitionsCustomDiskParam" } ], "description": "Disk parameters." } }, "required": [ "count", "name" ], "type": "object" }, "PartitionsCustomDiskParam": { "properties": { "interface": { "description": "Storage transport type.", "example": "nvme", "type": "string" }, "name": { "description": "Disk name.", "example": "1920 GB SSD NVMe Enterprise", "type": "string" }, "size": { "description": "Disk size in gigabytes.", "example": 1920, "type": "integer" }, "type": { "description": "Storage media type.", "example": "ssd", "type": "string" } }, "required": [ "interface", "name", "size", "type" ], "type": "object" }, "PartitionsCustomFeature": { "properties": { "link": { "description": "Feature link.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "type": "string" } }, "type": "object" }, "PartitionsCustomPcie": { "properties": { "count": { "description": "Number of hardware components.", "type": "integer" }, "feature": { "allOf": [ { "$ref": "#/definitions/PartitionsCustomFeature" } ], "description": "PCIe device feature information." }, "id": { "description": "Hardware component identifier.", "type": "integer" }, "name": { "description": "Hardware component name.", "type": "string" }, "param": { "allOf": [ { "$ref": "#/definitions/PartitionsCustomPcieParam" } ], "description": "PCIe device parameters." } }, "required": [ "count", "name" ], "type": "object" }, "PartitionsCustomPcieDiskPortParam": { "properties": { "count": { "description": "Number of disk ports.", "type": "integer" }, "interface": { "description": "List of supported disk interfaces.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "PartitionsCustomPcieParam": { "properties": { "disk_port_count": { "allOf": [ { "$ref": "#/definitions/PartitionsCustomPcieDiskPortParam" } ], "description": "List of supported disk interfaces.", "example": [ { "count": 8, "interface": [ "sata" ] } ] }, "name": { "description": "PCIe device name.", "type": "string" }, "type": { "description": "PCIe device type.", "example": "gpu", "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "PartitionsLocalDisk": { "properties": { "match": { "allOf": [ { "$ref": "#/definitions/PartitionsConfigNodeMatch" } ], "description": "Matching conditions for local drive." }, "members": { "description": "List of member devices.", "items": { "type": "string" }, "type": "array" }, "mode": { "description": "Controller's disk mode.", "enum": [ "raid", "hba" ], "example": "raid", "type": "string" }, "name": { "description": "Controller name.", "type": "string" }, "placement": { "description": "The serial number of the controller when using multiple controllers.", "example": 0, "minimum": 0, "type": "integer" }, "port_count": { "description": "Number of controller ports.", "type": "integer" }, "type": { "description": "Hardware node type.", "type": "string" }, "vendor": { "description": "LSI or Adaptec controller vendor when using different boards.", "enum": [ "lsi", "adaptec" ], "example": "lsi", "type": "string" } }, "required": [ "type" ], "type": "object" }, "PartitionsLocalDiskInput": { "properties": { "custom_config": { "allOf": [ { "$ref": "#/definitions/PartitionsCustomConfiguration" } ], "description": "Custom hardware configuration." }, "resource_uuid": { "description": "Resource identifier.", "type": "string" }, "service_uuid": { "description": "Service identifier.", "type": "string" } }, "type": "object" }, "PartitionsLocalDiskList": { "properties": { "*": { "additionalProperties": { "allOf": [ { "$ref": "#/definitions/PartitionsLocalDisk" } ], "description": "Local hardware node information." }, "type": "object" } }, "type": "object" }, "PartitionsLocalDisksResponse": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/PartitionsLocalDiskList" } ], "description": "List of local disks." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "PartitionsOSConfig": { "properties": { "partitions": { "description": "List of partitions. Template version v1 only.", "items": { "$ref": "#/definitions/PartitionUpdateModel" }, "type": "array" }, "partitions_config": { "allOf": [ { "$ref": "#/definitions/PartitionsConfigModel" } ], "description": "Full partitions configuration. Template version v2 only.", "example": { "b80a3a31-1ce1-531a-a271-78a33f9dddce": { "match": { "size": 2000, "type": "SATA HDD" }, "type": "local_drive" }, "root": { "device": "you_name_it_3", "fstype": "ext4", "mount": "/", "type": "filesystem" }, "you_name_it": { "device": "b80a3a31-1ce1-531a-a271-78a33f9dddce", "size": 999, "type": "partition" }, "you_name_it_2": { "device": "b80a3a31-1ce1-531a-a271-78a33f9dddce", "size": 999, "type": "partition" }, "you_name_it_3": { "level": "raid1", "members": [ "you_name_it", "you_name_it_2" ], "type": "soft_raid" } } }, "raid_type": { "description": "Configuration type of disks. Template version v1 only.", "example": "noraid", "type": "string" } }, "type": "object" }, "PartitionsValidate": { "properties": { "hardware_config": { "allOf": [ { "$ref": "#/definitions/PartitionsCustomConfiguration" } ], "description": "Configuration of custom hardware. Used when checking partitions." }, "os": { "description": "Name of the operating system family.", "example": "Ubuntu", "type": "string" }, "os_arch": { "description": "Architecture of the operating system.", "example": "x86", "type": "string" }, "os_version": { "description": "Version of the operating system.", "example": "20.04", "type": "string" }, "partitions_config": { "allOf": [ { "$ref": "#/definitions/PartitionsConfigModel" } ], "description": "Partitions configuration to validate.", "example": { "b80a3a31-1ce1-531a-a271-78a33f9dddce": { "match": { "size": 2000, "type": "SATA HDD" }, "type": "local_drive" }, "root": { "device": "you_name_it_3", "fstype": "ext4", "mount": "/", "type": "filesystem" }, "you_name_it": { "device": "b80a3a31-1ce1-531a-a271-78a33f9dddce", "size": 999, "type": "partition" }, "you_name_it_2": { "device": "b80a3a31-1ce1-531a-a271-78a33f9dddce", "size": 999, "type": "partition" }, "you_name_it_3": { "level": "raid1", "members": [ "you_name_it", "you_name_it_2" ], "type": "soft_raid" } } }, "template_version": { "description": "Version of the configuration. Only v2 supported.", "pattern": "^v\\d+$", "type": "string" } }, "required": [ "partitions_config" ], "type": "object" }, "PartitionsValidateResponse": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/PartitionsValidate" } ], "description": "Validated partitions configuration." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "PasswordModel": { "properties": { "password": { "description": "Operating system password.", "readOnly": true, "type": "string" } }, "required": [ "password" ], "type": "object" }, "PortApplyNetworkModel": { "properties": { "network_uuid": { "description": "List of network identifiers to apply to the port.", "items": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "type": "array" } }, "type": "object" }, "PortAuxLesserModel": { "properties": { "aux_network_info": { "allOf": [ { "$ref": "#/definitions/AuxNetworkInfoModel" } ], "description": "Additional network information." }, "port_name": { "description": "Port name.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "port_name", "uuid" ], "type": "object" }, "PortModel": { "properties": { "aggregate_physical_port_count": { "description": "Number of physical ports in the aggregate.", "type": "integer" }, "aux_network_info": { "description": "Additional network information.", "type": "object" }, "created": { "description": "Creation timestamp.", "type": "integer" }, "hw_uuid": { "description": "Hardware identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "is_aggregate": { "description": "If true, port is an aggregate port.", "type": "boolean" }, "is_apply": { "description": "If true, port configuration has been applied.", "type": "boolean" }, "is_enabled": { "description": "If true, port is enabled.", "type": "boolean" }, "is_processing": { "description": "If true, network is currently being processed.", "type": "boolean" }, "network": { "description": "List of networks associated with the port.", "items": { "$ref": "#/definitions/NetworkModel" }, "type": "array" }, "port_mode": { "description": "Port mode.", "enum": [ "access", "trunk", "hybrid" ], "example": "access", "type": "string" }, "port_name": { "description": "Port name.", "type": "string" }, "port_type": { "description": "Port type.", "enum": [ "local", "inet", "bmbs", "nas" ], "example": "local", "type": "string" }, "speed": { "description": "Port speed.", "enum": [ "AUTO", "10M", "100M", "1G", "10G", "25G", "40G", "100G" ], "example": "AUTO", "type": "string" }, "updated": { "description": "Last update timestamp.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "hw_uuid", "is_apply", "is_enabled", "is_processing", "port_name", "port_type", "speed", "uuid" ], "type": "object" }, "PortResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/PortModel" } ], "description": "Port object." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "PortViewModel": { "allOf": [ { "$ref": "#/definitions/ServiceView" }, { "properties": { "addition": { "description": "List of additional services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "available": { "description": "List of available configurations per location.", "items": { "$ref": "#/definitions/ServiceAvailable" }, "type": "array" }, "eol_date": { "description": "End-of-life date as a Unix timestamp.", "type": "integer" }, "is_editable": { "description": "Indicates whether the service configuration is editable.", "type": "boolean" }, "is_order": { "description": "Indicates whether the service is available for ordering.", "type": "boolean" }, "is_preorder": { "description": "Indicates whether the service is available for pre-ordering.", "type": "boolean" }, "is_price_plan_discount_enabled": { "description": "Indicates whether the price plan discount is enabled.", "type": "boolean" }, "is_primary": { "description": "Indicates whether the service is primary.", "type": "boolean" }, "is_qchange": { "description": "Indicates whether the service supports quick change.", "type": "boolean" }, "is_single_prolonged": { "description": "Indicates whether the service has a single renewal period.", "type": "boolean" }, "is_user_discount_enabled": { "description": "Indicates whether the user discount is enabled.", "type": "boolean" }, "location_price_collection": { "allOf": [ { "$ref": "#/definitions/LocationPriceModelView" } ], "description": "Price collection per location." }, "model": { "description": "Service model type.", "type": "string" }, "name": { "description": "Name of the service.", "type": "string" }, "price_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Price collection for the service." }, "price_plan_available": { "description": "List of available price plan UUIDs.", "items": { "type": "string" }, "type": "array" }, "primary": { "description": "List of primary services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "quantity": { "description": "Quantity of service units.", "type": "integer" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "setup_fee_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Setup fee price collection." }, "state": { "description": "Billing state of the service.", "type": "string" }, "tag_list": { "description": "List of tag objects assigned to the service.", "items": { "$ref": "#/definitions/ServiceTagCatalog" }, "type": "array" }, "tags": { "description": "List of tag names assigned to the service.", "items": { "type": "string" }, "type": "array" }, "tariff_line": { "description": "Billing option of the service.", "type": "string" }, "type": { "description": "Type of the port service.", "enum": [ "inet", "local", "direct" ], "example": "inet", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "addition", "available", "is_order", "is_preorder", "is_price_plan_discount_enabled", "is_primary", "is_single_prolonged", "is_user_discount_enabled", "model", "name", "price_collection", "price_plan_available", "primary", "service_tag", "setup_fee_collection", "state", "tag_list", "tags", "tariff_line", "type", "uuid" ], "type": "object" } ] }, "PowerReboot": { "properties": { "reboot": { "default": true, "description": "If true, reboots the resource.", "type": "boolean" } }, "type": "object" }, "PowerStatus": { "properties": { "console_enabled": { "description": "Indicates whether the console is enabled.", "type": "boolean" }, "maintenance": { "description": "Indicates whether the resource is in maintenance mode.", "type": "boolean" }, "maintenance_reason": { "description": "Reason for maintenance.", "type": "string" }, "power_state": { "description": "Current power state.", "type": "string" }, "target_power_state": { "description": "Target power state.", "type": "string" } }, "type": "object" }, "PowerSwitchStatus": { "properties": { "power_state": { "description": "If true, powers on the resource.", "type": "boolean" } }, "required": [ "power_state" ], "type": "object" }, "PriceModel": { "properties": { "EUR": { "$ref": "#/definitions/PricePeriodModel" }, "KES": { "$ref": "#/definitions/PricePeriodModel" }, "KZT": { "$ref": "#/definitions/PricePeriodModel" }, "RUB": { "$ref": "#/definitions/PricePeriodModel" }, "USD": { "$ref": "#/definitions/PricePeriodModel" }, "UZS": { "$ref": "#/definitions/PricePeriodModel" } }, "required": [ "EUR", "KES", "KZT", "RUB", "USD", "UZS" ], "type": "object" }, "PricePeriodModel": { "properties": { "day": { "minimum": 0.01, "type": "number" }, "hour": { "minimum": 0.01, "type": "number" }, "month": { "minimum": 0.01, "type": "number" }, "year": { "minimum": 0.01, "type": "number" } }, "type": "object" }, "PricePlanBaseModel": { "properties": { "commitment_period": { "description": "Commitment period in days.", "type": "integer" }, "dead": { "description": "Dead period in days.", "type": "integer" }, "discount": { "description": "Discount percentage.", "type": "integer" }, "grace": { "description": "Grace period in days.", "type": "integer" }, "name": { "description": "Price plan name.", "type": "string" }, "not_available_for_a_reason": { "description": "Reason why the price plan is not available.", "enum": [ "free", "non_resident", "reseller_owner_mismatch", "unavailable" ], "example": "free", "type": [ "string", "null" ] }, "period": { "description": "Billing period in days.", "type": "integer" }, "type": { "description": "Price plan type.", "enum": [ "free", "hour", "day", "month", "year", "service" ], "example": "free", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "dead", "grace" ], "type": "object" }, "PricePlanModel": { "properties": { "name": { "description": "Name of the tariff plan.", "type": "string" }, "period": { "description": "How many periods you will be charged for (e.g., 1 for monthly, 12 for yearly, 1 for daily).", "type": "integer" }, "type": { "description": "Billing period type (month, day).", "type": "string" }, "uuid": { "description": "Price plan identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "name", "period", "type", "uuid" ], "type": "object" }, "PricePlanResultListModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of price plans.", "items": { "$ref": "#/definitions/PricePlanBaseModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "PricePlanResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/PricePlanBaseModel" } ], "description": "Price plan information." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "RackLayoutModel": { "properties": { "location_uuid": { "description": "Network pool identifier for the resource.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "name": { "description": "Rack name.", "type": "string" } }, "required": [ "location_uuid", "name" ], "type": "object" }, "RackResourceLayoutModel": { "properties": { "rack": { "allOf": [ { "$ref": "#/definitions/RackLayoutModel" } ], "description": "Rack details." }, "resources": { "description": "List of resources in the rack.", "items": { "$ref": "#/definitions/ResourceLayoutModel" }, "type": "array" } }, "type": "object" }, "RaidModel": { "properties": { "description": { "description": "RAID configuration description.", "type": "string" }, "name": { "description": "RAID configuration name.", "type": "string" } }, "type": "object" }, "ReinstallInput": { "properties": { "reinstall": { "description": "Reinstall flag value.", "type": "integer" } }, "type": "object" }, "ResourceAdditionServiceModel": { "properties": { "is_qchange": { "description": "If true, quantity can be changed.", "type": "boolean" }, "is_single_prolonged": { "description": "If true, has single prolongation.", "type": "boolean" }, "model": { "description": "Service model type.", "type": "string" }, "name": { "description": "Service name.", "type": "string" }, "price": { "allOf": [ { "$ref": "#/definitions/PricePeriodModel" } ], "description": "Service pricing information." }, "price_plan_available": { "description": "Available price plans.", "items": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "type": "array" }, "quantity": { "description": "Number of resource units.", "type": "integer" }, "setup_fee": { "allOf": [ { "$ref": "#/definitions/PricePeriodModel" } ], "description": "Setup fee information." }, "state": { "description": "Current service state.", "type": "string" }, "tariff_line": { "description": "Tariff line identifier.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "model", "name", "price", "price_plan_available", "quantity", "setup_fee", "state", "tariff_line", "uuid" ], "type": "object" }, "ResourceAuxNetworkInfoModel": { "properties": { "config_name": { "description": "Server configuration description or service name depending on the resource type.", "type": "string" }, "location_uuid": { "description": "Network pool identifier for the resource.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "ports": { "description": "Ports identifiers.", "items": { "$ref": "#/definitions/PortAuxLesserModel" }, "type": "array" }, "state": { "description": "Current state.", "enum": [ "pending", "processing", "prolong", "paid", "deploy", "active", "expiring", "ending", "cancelling", "finishing", "unpaid", "blocked", "provided", "cancel", "deleted", "migration" ], "example": "pending", "type": "string" }, "user_desc": { "description": "Custom name assigned to the resource by the user.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "config_name", "location_uuid", "ports", "state", "uuid" ], "type": "object" }, "ResourceAuxNetworkInfoResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ResourceAuxNetworkInfoModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourceBaseAddModel": { "properties": { "location_uuid": { "description": "Network pool identifier for the resource.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "pay_day": { "description": "Payment day of month.", "maximum": 28, "minimum": 1, "type": "integer" }, "price_plan_uuid": { "description": "Price plan identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "quantity": { "default": 1, "description": "Number of resource units.", "maximum": 500, "minimum": 1, "type": "integer" }, "service_uuid": { "description": "Service identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "sync_key": { "description": "Synchronization key.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "user_desc": { "description": "Custom name assigned to the resource by the user.", "type": "string" } }, "required": [ "location_uuid", "price_plan_uuid", "service_uuid" ], "type": "object" }, "ResourceCancelModel": { "properties": { "immediately": { "description": "If false, disable auto-renewal (resource runs until period end). If true, cancel at current month end with refund for unused days.", "example": false, "type": "boolean" } }, "required": [ "immediately" ], "type": "object" }, "ResourceColocationInfoModel": { "properties": { "config_name": { "description": "Server configuration description or service name depending on the resource type.", "type": "string" }, "cpu": { "description": "CPU description.", "type": "string" }, "disk": { "description": "Disk description.", "type": "string" }, "info": { "description": "Name of the service for this resource.", "type": "string" }, "is_need_hw": { "description": "If true, hardware is required for this resource.", "type": "boolean" }, "is_primary": { "description": "If true, this is a primary resource.", "type": "boolean" }, "is_single_prolonged": { "description": "If true, single prolongation is enabled.", "type": "boolean" }, "ram": { "description": "RAM description.", "type": "string" }, "service_price": { "description": "Service price amount.", "type": "number" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "sn": { "description": "Serial number.", "type": "string" }, "unit": { "description": "Number of colocation units.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "config_name", "is_need_hw", "is_primary", "is_single_prolonged", "service_price", "sn", "unit", "uuid" ], "type": "object" }, "ResourceColocationInfoResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ResourceColocationInfoModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourceColocationInfoUpdateModel": { "properties": { "cpu": { "description": "CPU description.", "type": "string" }, "disk": { "description": "Disk description.", "type": "string" }, "ram": { "description": "RAM description.", "type": "string" } }, "type": "object" }, "ResourceCustomInfoModel": { "properties": { "active_upgrade": { "allOf": [ { "$ref": "#/definitions/ResourceUpgradeModel" } ], "description": "Currently active upgrade, if any." }, "auto_controller_links": { "description": "If true, disk controller links are configured automatically.", "type": "boolean" }, "config": { "allOf": [ { "$ref": "#/definitions/ServerConfigCustomDetailedModel" } ], "description": "Detailed server configuration." }, "config_name": { "description": "Server configuration description or service name depending on the resource type.", "type": "string" }, "info": { "description": "Name of the service for this resource.", "type": "string" }, "is_need_hw": { "description": "If true, hardware is required for this resource.", "type": "boolean" }, "is_primary": { "description": "If true, this is a primary resource.", "type": "boolean" }, "is_single_prolonged": { "description": "If true, single prolongation is enabled.", "type": "boolean" }, "service_price": { "description": "Service price amount.", "type": "number" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "template_service_uuid": { "description": "Template service identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "config_name", "is_need_hw", "is_primary", "is_single_prolonged", "service_price", "uuid" ], "type": "object" }, "ResourceCustomInfoResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ResourceCustomInfoModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourceCustomUpgradeAddModel": { "properties": { "auto_controller_links": { "description": "If true, automatically configure disk connection links.", "type": "boolean" }, "config": { "description": "Hardware configuration items.", "items": { "$ref": "#/definitions/ConfigCompactModel" }, "type": "array" }, "pay_currency": { "description": "Billing account type for debiting funds.", "enum": [ "bonus", "main", "vk_rub" ], "example": "bonus", "type": "string" } }, "type": "object" }, "ResourceDetailModel": { "properties": { "actual_dead_date": { "description": "Point in time when the resource will be deleted if it remains in final state (blocked, expiring, ending, cancelling, finishing).", "type": "integer" }, "actual_grace_date": { "description": "Point in time when the resource will be blocked if it remains in unpaid state (timestamp format).", "type": "integer" }, "addition_services": { "description": "List of additional services available for ordering for this primary resource.", "items": { "$ref": "#/definitions/ResourceAdditionServiceModel" }, "type": "array" }, "available_plan": { "description": "List of available price plan identifiers.", "items": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "type": "array" }, "billing": { "allOf": [ { "$ref": "#/definitions/BillingModel" } ], "description": "Billing information and settings." }, "campaign_uuid": { "description": "Promotional campaign identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "commitment_date": { "description": "Commitment start/end timestamp.", "type": "integer" }, "commitment_enabled": { "description": "If true, long-term commitment is enabled.", "type": "boolean" }, "config_name": { "description": "Server configuration description or service name depending on the resource type.", "type": "string" }, "created": { "description": "Point in time when the resource was created (timestamp format).", "type": "integer" }, "hw_uuid": { "description": "Hardware identifier associated with the resource.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "info": { "description": "Name of the service for this resource.", "type": "string" }, "integration_tag": { "description": "Tag for external system integration.", "type": "string" }, "is_migrated": { "description": "If true, the resource is migrated to the system.", "type": "boolean" }, "is_not_prolonged": { "description": "If true, prolongation is disabled.", "type": "boolean" }, "is_primary": { "description": "If true, is primary resource.", "type": "boolean" }, "is_processing": { "description": "If true, resource is currently being processed.", "type": "boolean" }, "is_single_prolonged": { "description": "If true, has single prolongation enabled.", "type": "boolean" }, "location_uuid": { "description": "Network pool identifier for the resource.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "ordered": { "description": "List of additional resources already ordered for this primary resource.", "items": { "$ref": "#/definitions/ResourceOrderedModel" }, "type": "array" }, "owner_id": { "description": "Identifier of the user who owns the resource.", "type": "integer" }, "paid_till": { "description": "Timestamp until which the resource was paid for.", "type": "integer" }, "pay_day": { "description": "Payment day for the resource.", "type": "integer" }, "previous_state": { "description": "Previous state.", "enum": [ "pending", "processing", "prolong", "paid", "deploy", "active", "expiring", "ending", "cancelling", "finishing", "unpaid", "blocked", "provided", "cancel", "deleted", "migration" ], "example": "pending", "type": "string" }, "primary_uuid": { "description": "Primary resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "project_uuid": { "description": "Project identifier.", "type": "string" }, "quantity": { "description": "Number of resource units.", "type": "integer" }, "service_type": { "description": "Type or category of service.", "type": "string" }, "service_uuid": { "description": "Service identifier for this resource.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "state": { "description": "Current state.", "enum": [ "pending", "processing", "prolong", "paid", "deploy", "active", "expiring", "ending", "cancelling", "finishing", "unpaid", "blocked", "provided", "cancel", "deleted", "migration" ], "example": "pending", "type": "string" }, "tags": { "description": "Associated tags.", "items": { "$ref": "#/definitions/ResourceTagModel" }, "type": "array" }, "user_desc": { "description": "Custom name assigned to the resource by the user.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "billing", "config_name", "hw_uuid", "is_not_prolonged", "is_primary", "is_processing", "is_single_prolonged", "location_uuid", "owner_id", "paid_till", "previous_state", "quantity", "service_type", "service_uuid", "state", "tags", "uuid" ], "type": "object" }, "ResourceLayoutListResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/RackResourceLayoutModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourceLayoutModel": { "properties": { "config_info": { "description": "Raw configuration information.", "type": "object" }, "created": { "description": "Point in time when the resource was created (timestamp format).", "type": "integer" }, "info": { "description": "Name of the service for this resource.", "type": "string" }, "ip": { "description": "IP address of the resource.", "type": "string" }, "location_uuid": { "description": "Network pool identifier for the resource.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "owner_id": { "description": "Identifier of the user who owns the resource.", "type": "integer" }, "project_uuid": { "description": "Project identifier.", "type": "string" }, "service_type": { "description": "Type or category of service.", "type": "string" }, "service_uuid": { "description": "Service identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "state": { "description": "Current state of the resource.", "enum": [ "pending", "processing", "prolong", "paid", "deploy", "active", "expiring", "ending", "cancelling", "finishing", "unpaid", "blocked", "provided", "cancel", "deleted", "migration" ], "example": "pending", "type": "string" }, "user_desc": { "description": "Custom name assigned to the resource by the user.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "location_uuid", "owner_id", "service_type", "service_uuid", "state", "uuid" ], "type": "object" }, "ResourceListResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/ResourceDetailModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourceModel": { "properties": { "actual_dead_date": { "description": "Point in time when the resource will be deleted if it remains in final state (blocked, expiring, ending, cancelling, finishing).", "type": "integer" }, "actual_grace_date": { "description": "Point in time when the resource will be blocked if it remains in unpaid state (timestamp format).", "type": "integer" }, "billing": { "allOf": [ { "$ref": "#/definitions/BillingModel" } ], "description": "Billing information and settings." }, "campaign_uuid": { "description": "Promotional campaign identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "commitment_date": { "description": "Commitment start/end timestamp.", "type": "integer" }, "commitment_enabled": { "description": "If true, long-term commitment is enabled.", "type": "boolean" }, "config_name": { "description": "Server configuration description or service name depending on the resource type.", "type": "string" }, "created": { "description": "Point in time when the resource was created (timestamp format).", "type": "integer" }, "hw_uuid": { "description": "Hardware identifier associated with the resource.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "info": { "description": "Name of the service for this resource.", "type": "string" }, "integration_tag": { "description": "Tag for external system integration.", "type": "string" }, "is_migrated": { "description": "If true, the resource is migrated to the system.", "type": "boolean" }, "is_not_prolonged": { "description": "If true, prolongation is disabled.", "type": "boolean" }, "is_primary": { "description": "If true, is primary resource.", "type": "boolean" }, "is_processing": { "description": "If true, resource is currently being processed.", "type": "boolean" }, "is_single_prolonged": { "description": "If true, has single prolongation enabled.", "type": "boolean" }, "location_uuid": { "description": "Network pool identifier for the resource.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "owner_id": { "description": "Identifier of the user who owns the resource.", "type": "integer" }, "paid_till": { "description": "Timestamp until which the resource was paid for.", "type": "integer" }, "pay_day": { "description": "Payment day for the resource.", "type": "integer" }, "previous_state": { "description": "Previous state.", "enum": [ "pending", "processing", "prolong", "paid", "deploy", "active", "expiring", "ending", "cancelling", "finishing", "unpaid", "blocked", "provided", "cancel", "deleted", "migration" ], "example": "pending", "type": "string" }, "primary_uuid": { "description": "Primary resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "project_uuid": { "description": "Project identifier.", "type": "string" }, "quantity": { "description": "Number of resource units.", "type": "integer" }, "service_type": { "description": "Type or category of service.", "type": "string" }, "service_uuid": { "description": "Service identifier for this resource.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "state": { "description": "Current state.", "enum": [ "pending", "processing", "prolong", "paid", "deploy", "active", "expiring", "ending", "cancelling", "finishing", "unpaid", "blocked", "provided", "cancel", "deleted", "migration" ], "example": "pending", "type": "string" }, "tags": { "description": "Associated tags.", "items": { "$ref": "#/definitions/ResourceTagModel" }, "type": "array" }, "user_desc": { "description": "Custom name assigned to the resource by the user.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "billing", "config_name", "hw_uuid", "is_not_prolonged", "is_primary", "is_processing", "is_single_prolonged", "location_uuid", "owner_id", "paid_till", "previous_state", "quantity", "service_type", "service_uuid", "state", "tags", "uuid" ], "type": "object" }, "ResourceNetworkEquipmentInfoModel": { "properties": { "config_name": { "description": "Server configuration description or service name depending on the resource type.", "type": "string" }, "info": { "description": "Name of the service for this resource.", "type": "string" }, "is_need_hw": { "description": "If true, hardware is required for this resource.", "type": "boolean" }, "is_primary": { "description": "If true, this is a primary resource.", "type": "boolean" }, "is_single_prolonged": { "description": "If true, single prolongation is enabled.", "type": "boolean" }, "model": { "description": "Equipment model name.", "type": "string" }, "service_price": { "description": "Service price amount.", "type": "number" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "slug": { "description": "URL-friendly equipment identifier.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "vendor": { "description": "Equipment vendor name.", "type": "string" } }, "required": [ "config_name", "is_need_hw", "is_primary", "is_single_prolonged", "service_price", "uuid" ], "type": "object" }, "ResourceNetworkEquipmentInfoResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ResourceNetworkEquipmentInfoModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourceOrderCompensationDetailModel": { "properties": { "comment": { "description": "Compensation comment.", "type": "string" }, "is_applied": { "description": "If true, compensation has been applied.", "type": "boolean" }, "month": { "description": "Month of the compensation period.", "type": "integer" }, "start": { "description": "Start compensation period timestamp.", "type": "integer" }, "stop": { "description": "Stop compensation period timestamp.", "type": "integer" }, "year": { "description": "Year of the compensation period.", "type": "integer" } }, "required": [ "comment", "is_applied", "month", "start", "stop", "year" ], "type": "object" }, "ResourceOrderedModel": { "properties": { "billing": { "allOf": [ { "$ref": "#/definitions/BillingModel" } ], "description": "Billing details." }, "created": { "description": "Point in time when the resource was created (timestamp format).", "type": "integer" }, "info": { "description": "Name of the service for this resource.", "type": "string" }, "is_not_prolonged": { "description": "If true, prolongation is disabled.", "type": "boolean" }, "is_single_prolonged": { "description": "If true, has single prolongation enabled.", "type": "boolean" }, "paid_till": { "description": "Timestamp until which the resource was paid for.", "type": "integer" }, "primary_uuid": { "description": "Primary resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "quantity": { "description": "Number of resource units.", "type": "integer" }, "service_price": { "description": "Service price amount.", "type": "number" }, "service_type": { "description": "Type or category of service.", "type": "string" }, "service_uuid": { "description": "Service identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "state": { "description": "Current state of the resource.", "enum": [ "pending", "processing", "prolong", "paid", "deploy", "active", "expiring", "ending", "cancelling", "finishing", "unpaid", "blocked", "provided", "cancel", "deleted", "migration" ], "example": "pending", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "billing", "is_not_prolonged", "is_single_prolonged", "paid_till", "quantity", "service_price", "service_type", "service_uuid", "state", "uuid" ], "type": "object" }, "ResourceOrdersModel": { "properties": { "created": { "description": "Point in time when the resource was created (timestamp format).", "type": "integer" }, "currency": { "description": "Currency code for the order.", "type": "string" }, "discount": { "description": "Discount percentage applied to the order.", "maximum": 99, "minimum": 0, "type": "integer" }, "due_date": { "description": "Timestamp of the end of the current billing period.", "type": "integer" }, "name": { "description": "Name of the order.", "type": "string" }, "paid_till": { "description": "Timestamp until which the resource was paid for.", "type": "integer" }, "pay_currency": { "description": "Billing account type for debiting funds.", "type": "string" }, "price": { "description": "Total price of the order.", "type": "number" }, "price_plan": { "description": "Price plan associated with the order.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "resource_primary_uuid": { "description": "Primary resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "resource_uuid": { "description": "Resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "service_model": { "description": "Service model for resource.", "type": "string" }, "state": { "description": "Current state of the order.", "type": "string" }, "type": { "description": "Type of the order.", "enum": [ "payment", "setup_fee", "correction" ], "example": "payment", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "created", "currency", "discount", "due_date", "name", "paid_till", "pay_currency", "price", "price_plan", "resource_primary_uuid", "resource_uuid", "state", "type", "uuid" ], "type": "object" }, "ResourceOrdersStatModel": { "properties": { "month": { "description": "Month identifier.", "type": "string" }, "order": { "description": "List of orders for the month.", "items": { "$ref": "#/definitions/ResourceOrdersModel" }, "type": "array" } }, "required": [ "month" ], "type": "object" }, "ResourceOrdersStatResultListModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/ResourceOrdersStatModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourcePrebuiltUpgradeRequestModel": { "properties": { "resource_uuid": { "description": "Resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "ticket_text": { "description": "Support ticket text describing the upgrade request.", "type": "string" } }, "required": [ "resource_uuid", "ticket_text" ], "type": "object" }, "ResourceRestoreModel": { "properties": { "next_price_plan_uuid": { "description": "Next price plan identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "next_price_plan_uuid" ], "type": "object" }, "ResourceResultListModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/ResourceModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourceResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ResourceDetailModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourceServerInfoModel": { "properties": { "config_name": { "description": "Server configuration description or service name depending on the resource type.", "type": "string" }, "info": { "description": "Name of the service for this resource.", "type": "string" }, "is_need_hw": { "description": "If true, hardware is required for this resource.", "type": "boolean" }, "is_primary": { "description": "If true, this is a primary resource.", "type": "boolean" }, "is_single_prolonged": { "description": "If true, single prolongation is enabled.", "type": "boolean" }, "service_price": { "description": "Service price amount.", "type": "number" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "config_name", "is_need_hw", "is_primary", "is_single_prolonged", "service_price", "uuid" ], "type": "object" }, "ResourceServerInfoResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ResourceServerInfoModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourceStartAdditionalListModel": { "properties": { "extra_context": { "description": "Additional context data.", "type": "object" }, "pay_currency": { "description": "Billing account type for debiting funds.", "enum": [ "bonus", "main", "vk_rub" ], "example": "bonus", "type": "string" }, "services": { "description": "List of additional services.", "items": { "$ref": "#/definitions/ResourceStartAdditionalNestedModel" }, "type": "array" }, "sync_key": { "description": "Synchronization key.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "type": "object" }, "ResourceStartAdditionalModel": { "properties": { "demo": { "default": false, "description": "If true, demo mode.", "type": "boolean" }, "pay_currency": { "description": "Billing account type for debiting funds.", "enum": [ "bonus", "main", "vk_rub" ], "example": "bonus", "type": "string" }, "quantity": { "default": 1, "description": "Number of units.", "maximum": 10000, "minimum": 1, "type": "integer" }, "service_uuid": { "description": "Service identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "sync_key": { "description": "Synchronization key.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "service_uuid" ], "type": "object" }, "ResourceStartAdditionalNestedModel": { "properties": { "demo": { "default": false, "description": "If true, demo mode.", "type": "boolean" }, "pay_currency": { "description": "Billing account type for debiting funds.", "enum": [ "bonus", "main", "vk_rub" ], "example": "bonus", "type": "string" }, "quantity": { "default": 1, "description": "Number of units.", "maximum": 10000, "minimum": 1, "type": "integer" }, "service_uuid": { "description": "Service identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "sync_key": { "description": "Synchronization key.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "service_uuid" ], "type": "object" }, "ResourceStartColocationModel": { "allOf": [ { "$ref": "#/definitions/ResourceBaseAddModel" }, { "$ref": "#/definitions/ResourceStartModel" }, { "properties": { "ip_list": { "description": "IP list for servers.", "items": { "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "type": "array" }, "limit_type": { "description": "Network limit type.", "enum": [ "speed", "traffic" ], "example": "speed", "type": "string" }, "sn": { "description": "Serial number.", "type": "string" }, "user_desc": { "description": "Custom name assigned to the resource by the user.", "type": "string" } }, "required": [ "sn" ], "type": "object" } ] }, "ResourceStartFirewallModel": { "allOf": [ { "$ref": "#/definitions/ResourceBaseAddModel" }, { "$ref": "#/definitions/ResourceStartModel" }, { "properties": { "extra_content": { "allOf": [ { "$ref": "#/definitions/FirewallExtraContent" } ], "description": "Additional firewall configuration." }, "limit_type": { "description": "Network limit type.", "enum": [ "speed", "traffic" ], "example": "speed", "type": "string" }, "user_desc": { "description": "Custom name assigned to the resource by the user.", "type": "string" } }, "type": "object" } ] }, "ResourceStartModel": { "properties": { "extra_period": { "default": 0, "description": "Prepayment for base plan period.", "minimum": 0, "type": "integer" }, "pay_currency": { "description": "Billing account type for debiting funds.", "enum": [ "bonus", "main", "vk_rub" ], "example": "bonus", "type": "string" }, "pay_day": { "description": "Prepayment day.", "type": "integer" } }, "type": "object" }, "ResourceStartNetworkModel": { "allOf": [ { "$ref": "#/definitions/ResourceBaseAddModel" }, { "$ref": "#/definitions/ResourceStartModel" }, { "properties": { "extra_context": { "description": "Additional context data.", "type": "object" } }, "type": "object" } ] }, "ResourceStartPortModel": { "allOf": [ { "$ref": "#/definitions/ResourceBaseAddModel" }, { "$ref": "#/definitions/ResourceStartModel" }, { "properties": { "extra_context": { "description": "Additional context data.", "type": "object" } }, "type": "object" } ] }, "ResourceStartServerCustomModel": { "allOf": [ { "$ref": "#/definitions/ResourceStartServerchipModel" }, { "properties": { "client_comment": { "description": "Client comment.", "type": "string" }, "config": { "description": "Hardware configuration.", "items": { "$ref": "#/definitions/ConfigCompactModel" }, "type": "array" }, "enable_monitoring_types": { "items": { "description": "Monitoring types to enable on server.", "enum": [ "NODE", "IPMI" ], "example": "NODE", "type": "string" }, "type": "array" }, "ip_list": { "description": "IP list for servers.", "items": { "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "type": "array" }, "raid_support_esxi": { "description": "If true, install RAID controller compatible with ESXi.", "type": "boolean" }, "reassembly_ram": { "description": "If true, RAM reassembly is required.", "type": "boolean" }, "template_service_uuid": { "description": "Template service identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "type": "object" } ] }, "ResourceStartServerModel": { "allOf": [ { "$ref": "#/definitions/ResourceStartServerchipModel" }, { "properties": { "enable_monitoring_types": { "items": { "description": "Monitoring types to enable on server.", "enum": [ "NODE", "IPMI" ], "example": "NODE", "type": "string" }, "type": "array" }, "local_ip_list": { "description": "Local IP list for servers.", "items": { "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "type": "array" }, "local_subnet_uuid": { "description": "Local subnet identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "type": "object" } ] }, "ResourceStartServerchipModel": { "allOf": [ { "$ref": "#/definitions/ResourceBaseAddModel" }, { "$ref": "#/definitions/OSConfigCreateInput" }, { "$ref": "#/definitions/ResourceStartModel" }, { "properties": { "campaign_uuid": { "description": "Auction Discount Campaign identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "ip_list": { "description": "IP list for servers.", "items": { "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "type": "array" }, "limit_type": { "description": "Network limit type.", "enum": [ "speed", "traffic" ], "example": "speed", "type": "string" }, "local_network_required": { "description": "Sets whether local network should be created for the first server.", "type": "boolean" }, "user_desc": { "description": "Custom name assigned to the resource by the user.", "type": "string" } }, "required": [ "user_desc" ], "type": "object" } ] }, "ResourceTagCreateUpdateModel": { "properties": { "name": { "description": "Resource tag name.", "maxLength": 64, "type": "string" } }, "required": [ "name" ], "type": "object" }, "ResourceTagManageModel": { "properties": { "tags": { "description": "List of tag names.", "items": { "maxLength": 64, "type": "string" }, "maxItems": 10, "minItems": 0, "type": "array" } }, "type": "object" }, "ResourceTagModel": { "properties": { "name": { "description": "Resource tag name.", "maxLength": 64, "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "name", "uuid" ], "type": "object" }, "ResourceTagResultListModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/ResourceTagModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourceTagResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ResourceTagModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResourceUpdateModel": { "properties": { "pay_day": { "description": "Payment day.", "type": "integer" }, "price_plan_uuid": { "description": "Price plan identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "user_desc": { "description": "Custom name assigned to the resource by the user.", "type": "string" } }, "type": "object" }, "ResourceUpdateProjectModel": { "properties": { "project_uuid": { "description": "Project identifier.", "type": "string" } }, "required": [ "project_uuid" ], "type": "object" }, "ResourceUpgradeModel": { "properties": { "active": { "description": "If true, the upgrade is currently active.", "type": "boolean" }, "config": { "allOf": [ { "$ref": "#/definitions/ServerConfigCustomDetailedModel" } ], "description": "Detailed server configuration." }, "config_uuid": { "description": "Configuration identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "created": { "description": "Point in time when the resource was created (timestamp format).", "type": "integer" }, "hw_uuid": { "description": "Hardware identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "is_complex": { "description": "If true, upgrade involves multiple components.", "type": "boolean" }, "resource_uuid": { "description": "Resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "service_price_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Service pricing details for the upgrade." }, "state": { "description": "Current state of the upgrade.", "enum": [ "ordered", "deployed", "done", "cancelled" ], "example": "ordered", "type": "string" }, "updated": { "description": "Point in time when the upgrade was last updated (timestamp format).", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "is_complex", "resource_uuid", "service_price_collection", "state", "uuid" ], "type": "object" }, "ResourceUpgradeResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ResourceUpgradeModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseBaseAsyncModel": { "properties": { "execution_time": { "description": "Task execution time in seconds.", "type": "number" }, "item_count": { "description": "Total number of items in the result set.", "type": "integer" }, "limit": { "description": "Number of items per page for paginated results.", "type": "integer" }, "page": { "description": "Current page number for paginated results.", "type": "integer" }, "progress": { "description": "Task completion progress in percentage.", "type": "integer" }, "result": { "description": "Task execution result data.", "type": "object" }, "status": { "description": "Current status of the task.", "type": "string" }, "task_id": { "description": "Unique task identifier UUID v4.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseBaseModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/Result" } ], "description": "Object which contains result of computed request" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "result", "task_id" ], "type": "object" }, "ResponseBlockStorageBetaFlag": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/BlockStorageBetaFlag" } ], "description": "Block storage beta flag data." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseColocationListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/ColocationViewModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseColocationResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ColocationViewModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseConsole": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/Console" } ], "description": "Console information." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseDevice": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/Device" } ], "description": "Boot device information." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseDeviceInfoList": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of boot devices.", "items": { "$ref": "#/definitions/DeviceInfo" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseFirewallListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/FirewallViewModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseFirewallResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/FirewallViewModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseNameListModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of names.", "items": { "$ref": "#/definitions/NameBase" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseNameResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/NameBase" } ], "description": "Object name." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseNameTagsListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of tags.", "items": { "$ref": "#/definitions/TagBase" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseNetworkEquipmentListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/NetworkEquipmentViewModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseNetworkEquipmentResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/NetworkEquipmentViewModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseNetworkListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/NetworkViewModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseNetworkResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/NetworkViewModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseOSConfig": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/OSConfig" } ], "description": "Operating system configuration information." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseOSPassword": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/PasswordModel" } ], "description": "Operating system password information." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseOSTemplateList": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/OSTemplate" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponsePortListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/PortViewModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponsePortResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/PortViewModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponsePowerStatus": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/DriverStatus" } ], "description": "Result containing driver status." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseServerCustomListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/ServerCustomViewModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseServerCustomResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ServerCustomViewModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseServerListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/ServerViewModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseServerResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ServerViewModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseServiceBillingResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/BillingModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseServiceCustomUpgradeBillingResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/UpgradeBillingModel" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseServiceListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseServiceResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ServiceView" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseServiceTagCatalogListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "items": { "$ref": "#/definitions/ServiceTagCatalog" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseServiceTagCatalogResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "$ref": "#/definitions/ServiceTagCatalog" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseSpeedGraph": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of speed graph data points. Each data point contains three values: 1 - Unix timestamp, 2 - incoming speed in bit/s, 3 - outgoing speed in bit/s.", "items": { "items": { "type": "integer" }, "maxItems": 3, "minItems": 3, "type": "array" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "result", "task_id" ], "type": "object" }, "ResponseTagListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of tags.", "items": { "$ref": "#/definitions/TagBase" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseTagNamesListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of names.", "items": { "$ref": "#/definitions/NameBase" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseTagResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/TagBase" } ], "description": "Object tag." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseTrafficConsumption": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/TrafficConsumptionMessage" } ], "description": "Traffic consumption data." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseUserNameListResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of user names.", "items": { "$ref": "#/definitions/UserNameBase" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "ResponseUserNameResult": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/UserNameBase" } ], "description": "User name object." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "Result": { "properties": {}, "type": "object" }, "ResultActiveTasks": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of active tasks.", "items": { "$ref": "#/definitions/ActiveTask" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "RuleModel": { "properties": { "action": { "description": "Action to perform (allow or deny).", "enum": [ "accept", "discard" ], "example": "accept", "type": "string" }, "counter": { "default": false, "description": "If true, enables packet counting for this rule.", "type": "boolean" }, "description": { "description": "Rule description.", "maxLength": 400, "type": "string" }, "direction": { "description": "Traffic direction (inbound or outbound).", "enum": [ "input", "output" ], "example": "input", "type": "string" }, "dst_address": { "description": "List of destination IPv4 addresses or networks in CIDR notation.", "items": { "example": "10.0.0.0/29", "maxLength": 18, "minLength": 9, "type": "string" }, "type": "array" }, "dst_port": { "description": "List of destination ports. Format: single port ('90'), port range ('100-110'), or both.", "items": { "type": "string" }, "type": "array" }, "index": { "description": "Rule priority index.", "maximum": 15, "minimum": 1, "type": "integer" }, "protocol": { "description": "List of protocols.", "items": { "enum": [ "any", "gre", "icmp", "ipip", "tcp", "udp", "esp", "ah" ], "example": "any", "type": "string" }, "type": "array" }, "src_address": { "description": "List of source IPv4 addresses or networks in CIDR notation.", "items": { "example": "10.0.0.0/29", "maxLength": 18, "minLength": 9, "type": "string" }, "type": "array" }, "src_port": { "description": "List of source ports. Format: single port ('90'), port range ('100-110'), or both.", "items": { "type": "string" }, "type": "array" } }, "required": [ "action", "direction", "index" ], "type": "object" }, "ServerBoard": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ServerBoardDetailed": { "allOf": [ { "$ref": "#/definitions/ServerBoard" }, { "properties": { "count": { "type": "integer" }, "feature": { "$ref": "#/definitions/HardmathConfigItemFeatureModel" }, "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "$ref": "#/definitions/ConfigItemPriceModel" } }, "required": [ "name" ], "type": "object" } ] }, "ServerCPU": { "properties": { "base_freq": { "type": "number" }, "cores_per_cpu": { "type": "integer" }, "count": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "base_freq", "cores_per_cpu", "count", "name" ], "type": "object" }, "ServerCPUDetailed": { "allOf": [ { "$ref": "#/definitions/ServerCPU" }, { "properties": { "base_freq": { "type": "number" }, "cores_per_cpu": { "type": "integer" }, "count": { "type": "integer" }, "feature": { "$ref": "#/definitions/HardmathConfigItemFeatureModel" }, "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "$ref": "#/definitions/ConfigItemPriceModel" } }, "required": [ "base_freq", "cores_per_cpu", "count", "name" ], "type": "object" } ] }, "ServerCase": { "properties": { "name": { "type": "string" }, "power_supply": { "type": "integer" }, "unit": { "type": "integer" } }, "required": [ "name", "power_supply", "unit" ], "type": "object" }, "ServerCaseDetailed": { "allOf": [ { "$ref": "#/definitions/ServerCase" }, { "properties": { "count": { "type": "integer" }, "feature": { "$ref": "#/definitions/HardmathConfigItemFeatureModel" }, "id": { "type": "integer" }, "name": { "type": "string" }, "power_supply": { "type": "integer" }, "price": { "$ref": "#/definitions/ConfigItemPriceModel" }, "unit": { "type": "integer" } }, "required": [ "name", "power_supply", "unit" ], "type": "object" } ] }, "ServerConfigCustomDetailedModel": { "properties": { "board": { "items": { "$ref": "#/definitions/ServerBoardDetailed" }, "type": "array" }, "case": { "items": { "$ref": "#/definitions/ServerCaseDetailed" }, "type": "array" }, "cpu": { "items": { "$ref": "#/definitions/ServerCPUDetailed" }, "type": "array" }, "disk": { "items": { "$ref": "#/definitions/ServerCustomDiskDetailed" }, "type": "array" }, "gpu": { "items": { "$ref": "#/definitions/ServerGPUDetailed" }, "type": "array" }, "is_complex_assembly": { "default": false, "type": "boolean" }, "misc": { "items": { "$ref": "#/definitions/ServerMiscDetailed" }, "type": "array" }, "ocp": { "items": { "$ref": "#/definitions/ServerOCPDetailed" }, "type": "array" }, "pcie": { "items": { "$ref": "#/definitions/ServerPCIEDetailed" }, "type": "array" }, "price": { "$ref": "#/definitions/ConfigItemPriceModel" }, "ram": { "items": { "$ref": "#/definitions/ServerCustomRAMDetailed" }, "type": "array" }, "uuid": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "version": { "type": "string" } }, "required": [ "uuid" ], "type": "object" }, "ServerCustomDisk": { "allOf": [ { "$ref": "#/definitions/ServerDisk" }, { "properties": { "count": { "description": "Количество дисков указанного типа", "type": "integer" }, "name": { "default": "", "type": "string" }, "size": { "description": "Объём памяти в Гигабайтах (GiB)", "type": "integer" }, "type": { "type": "string" } }, "required": [ "count", "size", "type" ], "type": "object" } ] }, "ServerCustomDiskDetailed": { "allOf": [ { "$ref": "#/definitions/ServerCustomDisk" }, { "properties": { "count": { "description": "Количество дисков указанного типа", "type": "integer" }, "feature": { "$ref": "#/definitions/HardmathConfigItemFeatureModel" }, "id": { "type": "integer" }, "name": { "default": "", "type": "string" }, "price": { "$ref": "#/definitions/ConfigItemPriceModel" }, "size": { "description": "Объём памяти в Гигабайтах (GiB)", "type": "integer" }, "type": { "type": "string" } }, "required": [ "count", "size", "type" ], "type": "object" } ] }, "ServerCustomRAM": { "allOf": [ { "$ref": "#/definitions/ServerRAM" }, { "properties": { "count": { "type": "integer" }, "name": { "default": "", "type": "string" }, "size": { "description": "Объём памяти в Гигабайтах (GiB)", "type": "integer" }, "type": { "type": "string" } }, "required": [ "count", "size", "type" ], "type": "object" } ] }, "ServerCustomRAMDetailed": { "allOf": [ { "$ref": "#/definitions/ServerCustomRAM" }, { "properties": { "count": { "type": "integer" }, "feature": { "$ref": "#/definitions/HardmathConfigItemFeatureModel" }, "id": { "type": "integer" }, "name": { "default": "", "type": "string" }, "price": { "$ref": "#/definitions/ConfigItemPriceModel" }, "size": { "description": "Объём памяти в Гигабайтах (GiB)", "type": "integer" }, "type": { "type": "string" } }, "required": [ "count", "size", "type" ], "type": "object" } ] }, "ServerCustomViewModel": { "allOf": [ { "$ref": "#/definitions/ServiceView" }, { "$ref": "#/definitions/ServiceBase" }, { "properties": { "addition": { "description": "List of additional services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "available": { "description": "List of available configurations per location.", "items": { "$ref": "#/definitions/ServiceAvailable" }, "type": "array" }, "eol_date": { "description": "End-of-life date as a Unix timestamp.", "type": "integer" }, "is_editable": { "description": "Indicates whether the service configuration is editable.", "type": "boolean" }, "is_manual_erase": { "description": "Indicates whether manual disk erase is required.", "type": "boolean" }, "is_manual_os_install": { "description": "Indicates whether manual OS installation is required.", "type": "boolean" }, "is_order": { "description": "Indicates whether the service is available for ordering.", "type": "boolean" }, "is_preorder": { "description": "Indicates whether the service is available for pre-ordering.", "type": "boolean" }, "is_price_plan_discount_enabled": { "description": "Indicates whether the price plan discount is enabled.", "type": "boolean" }, "is_primary": { "description": "Indicates whether the service is primary.", "type": "boolean" }, "is_qchange": { "description": "Indicates whether the service supports quick change.", "type": "boolean" }, "is_single_prolonged": { "description": "Indicates whether the service has a single renewal period.", "type": "boolean" }, "is_template_service_required": { "description": "Indicates whether a template service is required.", "type": "boolean" }, "is_user_discount_enabled": { "description": "Indicates whether the user discount is enabled.", "type": "boolean" }, "location_price_collection": { "allOf": [ { "$ref": "#/definitions/LocationPriceModelView" } ], "description": "Price collection per location." }, "market_segment_cpu": { "description": "Market segment of the CPU.", "type": "string" }, "model": { "description": "Service model type.", "type": "string" }, "name": { "description": "Name of the service.", "type": "string" }, "price_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Price collection for the service." }, "price_plan_available": { "description": "List of available price plan UUIDs.", "items": { "type": "string" }, "type": "array" }, "primary": { "description": "List of primary services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "quantity": { "description": "Quantity of service units.", "type": "integer" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "setup_fee_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Setup fee price collection." }, "state": { "description": "Billing state of the service.", "type": "string" }, "tag_list": { "description": "List of tag objects assigned to the service.", "items": { "$ref": "#/definitions/ServiceTagCatalog" }, "type": "array" }, "tags": { "description": "List of tag names assigned to the service.", "items": { "type": "string" }, "type": "array" }, "tariff_line": { "description": "Billing option of the service.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "addition", "available", "is_order", "is_preorder", "is_price_plan_discount_enabled", "is_primary", "is_single_prolonged", "is_user_discount_enabled", "model", "name", "price_collection", "price_plan_available", "primary", "service_tag", "setup_fee_collection", "state", "tag_list", "tags", "tariff_line", "uuid" ], "type": "object" } ] }, "ServerDisk": { "properties": { "count": { "description": "Количество дисков указанного типа", "type": "integer" }, "size": { "description": "Объём памяти в Гигабайтах (GiB)", "type": "integer" }, "type": { "type": "string" } }, "required": [ "count", "size", "type" ], "type": "object" }, "ServerGPU": { "properties": { "count": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "count", "name" ], "type": "object" }, "ServerGPUDetailed": { "allOf": [ { "$ref": "#/definitions/ServerGPU" }, { "properties": { "count": { "type": "integer" }, "feature": { "$ref": "#/definitions/HardmathConfigItemFeatureModel" }, "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "$ref": "#/definitions/ConfigItemPriceModel" } }, "required": [ "count", "name" ], "type": "object" } ] }, "ServerMisc": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ServerMiscDetailed": { "allOf": [ { "$ref": "#/definitions/ServerMisc" }, { "properties": { "count": { "type": "integer" }, "feature": { "$ref": "#/definitions/HardmathConfigItemFeatureModel" }, "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "$ref": "#/definitions/ConfigItemPriceModel" } }, "required": [ "name" ], "type": "object" } ] }, "ServerOCP": { "properties": { "count": { "default": 0, "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "count", "name", "type" ], "type": "object" }, "ServerOCPDetailed": { "allOf": [ { "$ref": "#/definitions/ServerOCP" }, { "properties": { "count": { "default": 0, "type": "integer" }, "feature": { "$ref": "#/definitions/HardmathConfigItemFeatureModel" }, "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "$ref": "#/definitions/ConfigItemPriceModel" }, "type": { "type": "string" } }, "required": [ "count", "name", "type" ], "type": "object" } ] }, "ServerPCIE": { "properties": { "count": { "default": 0, "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "count", "name", "type" ], "type": "object" }, "ServerPCIEDetailed": { "allOf": [ { "$ref": "#/definitions/ServerPCIE" }, { "properties": { "count": { "default": 0, "type": "integer" }, "feature": { "$ref": "#/definitions/HardmathConfigItemFeatureModel" }, "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "$ref": "#/definitions/ConfigItemPriceModel" }, "type": { "type": "string" } }, "required": [ "count", "name", "type" ], "type": "object" } ] }, "ServerRAM": { "properties": { "count": { "type": "integer" }, "size": { "description": "Объём памяти в Гигабайтах (GiB)", "type": "integer" }, "type": { "type": "string" } }, "required": [ "count", "size", "type" ], "type": "object" }, "ServerViewModel": { "allOf": [ { "$ref": "#/definitions/ServiceView" }, { "properties": { "addition": { "description": "List of additional services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "arch_type": { "description": "Architecture type of the server.", "enum": [ "x86_64", "i386", "aarch64", "aarch64_pi4", "aarch64_m1" ], "example": "x86_64", "type": "string" }, "available": { "description": "List of available configurations per location.", "items": { "$ref": "#/definitions/ServiceAvailable" }, "type": "array" }, "config": { "description": "List of hardware configurations.", "items": { "$ref": "#/definitions/ConfigCompactModel" }, "type": "array" }, "config_name": { "description": "Name of the server configuration.", "type": "string" }, "cpu": { "allOf": [ { "$ref": "#/definitions/ServerCPU" } ], "description": "CPU configuration of the server." }, "disk": { "description": "List of disk drives of the server.", "items": { "$ref": "#/definitions/ServerDisk" }, "type": "array" }, "eol_date": { "description": "End-of-life date as a Unix timestamp.", "type": "integer" }, "gpu": { "allOf": [ { "$ref": "#/definitions/ServerGPU" } ], "description": "GPU configuration of the server." }, "is_configurable": { "description": "Indicates whether the server configuration is customizable.", "type": "boolean" }, "is_editable": { "description": "Indicates whether the service configuration is editable.", "type": "boolean" }, "is_manual_erase": { "description": "Indicates whether manual disk erase is required.", "type": "boolean" }, "is_manual_os_install": { "description": "Indicates whether manual OS installation is required.", "type": "boolean" }, "is_order": { "description": "Indicates whether the service is available for ordering.", "type": "boolean" }, "is_preorder": { "description": "Indicates whether the service is available for pre-ordering.", "type": "boolean" }, "is_price_plan_discount_enabled": { "description": "Indicates whether the price plan discount is enabled.", "type": "boolean" }, "is_primary": { "description": "Indicates whether the service is primary.", "type": "boolean" }, "is_qchange": { "description": "Indicates whether the service supports quick change.", "type": "boolean" }, "is_single_prolonged": { "description": "Indicates whether the service has a single renewal period.", "type": "boolean" }, "is_user_discount_enabled": { "description": "Indicates whether the user discount is enabled.", "type": "boolean" }, "location_price_collection": { "allOf": [ { "$ref": "#/definitions/LocationPriceModelView" } ], "description": "Price collection per location." }, "model": { "description": "Service model type.", "type": "string" }, "name": { "description": "Name of the service.", "type": "string" }, "price_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Price collection for the service." }, "price_plan_available": { "description": "List of available price plan UUIDs.", "items": { "type": "string" }, "type": "array" }, "primary": { "description": "List of primary services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "quantity": { "description": "Quantity of service units.", "type": "integer" }, "ram": { "description": "List of RAM modules of the server.", "items": { "$ref": "#/definitions/ServerRAM" }, "type": "array" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "setup_fee_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Setup fee price collection." }, "state": { "description": "Billing state of the service.", "type": "string" }, "tag_list": { "description": "List of tag objects assigned to the service.", "items": { "$ref": "#/definitions/ServiceTagCatalog" }, "type": "array" }, "tags": { "description": "List of tag names assigned to the service.", "items": { "type": "string" }, "type": "array" }, "tariff_line": { "description": "Billing option of the service.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "addition", "available", "config_name", "cpu", "disk", "is_order", "is_preorder", "is_price_plan_discount_enabled", "is_primary", "is_single_prolonged", "is_user_discount_enabled", "model", "name", "price_collection", "price_plan_available", "primary", "ram", "service_tag", "setup_fee_collection", "state", "tag_list", "tags", "tariff_line", "uuid" ], "type": "object" } ] }, "ServiceAvailable": { "properties": { "count": { "description": "Total number of available configurations.", "type": "integer" }, "location": { "description": "Location identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "plan_count": { "description": "List of available configurations per price plan.", "items": { "$ref": "#/definitions/ServicePlanAvailable" }, "type": "array" } }, "type": "object" }, "ServiceBase": { "properties": { "available": { "description": "List of available configurations per location.", "items": { "$ref": "#/definitions/ServiceAvailable" }, "type": "array" }, "eol_date": { "description": "End-of-life date as a Unix timestamp.", "type": "integer" }, "is_editable": { "description": "Indicates whether the service configuration is editable.", "type": "boolean" }, "is_order": { "description": "Indicates whether the service is available for ordering.", "type": "boolean" }, "is_preorder": { "description": "Indicates whether the service is available for pre-ordering.", "type": "boolean" }, "is_price_plan_discount_enabled": { "description": "Indicates whether the price plan discount is enabled.", "type": "boolean" }, "is_primary": { "description": "Indicates whether the service is primary.", "type": "boolean" }, "is_qchange": { "description": "Indicates whether the service supports quick change.", "type": "boolean" }, "is_single_prolonged": { "description": "Indicates whether the service has a single renewal period.", "type": "boolean" }, "is_user_discount_enabled": { "description": "Indicates whether the user discount is enabled.", "type": "boolean" }, "location_price_collection": { "allOf": [ { "$ref": "#/definitions/LocationPriceModelView" } ], "description": "Price collection per location." }, "model": { "description": "Service model type.", "type": "string" }, "name": { "description": "Name of the service.", "type": "string" }, "price_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Price collection for the service." }, "quantity": { "description": "Quantity of service units.", "type": "integer" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "setup_fee_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Setup fee price collection." }, "state": { "description": "Billing state of the service.", "type": "string" }, "tag_list": { "description": "List of tag objects assigned to the service.", "items": { "$ref": "#/definitions/ServiceTagCatalog" }, "type": "array" }, "tags": { "description": "List of tag names assigned to the service.", "items": { "type": "string" }, "type": "array" }, "tariff_line": { "description": "Billing option of the service.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "available", "is_order", "is_preorder", "is_price_plan_discount_enabled", "is_primary", "is_single_prolonged", "is_user_discount_enabled", "model", "name", "price_collection", "service_tag", "setup_fee_collection", "state", "tag_list", "tags", "tariff_line", "uuid" ], "type": "object" }, "ServiceBillingCheckModel": { "properties": { "campaign_uuid": { "description": "Discount campaign identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "location_uuid": { "description": "Location identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "pay_currency": { "description": "Currency for billing payment.", "enum": [ "bonus", "main", "vk_rub" ], "example": "bonus", "type": "string" }, "pay_day": { "description": "Day of the month for billing payment.", "maximum": 28, "minimum": 1, "type": "integer" }, "price_plan_uuid": { "description": "Price plan identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "quantity": { "default": 1, "description": "Number of service units to calculate billing for.", "minimum": 1, "type": "integer" } }, "required": [ "location_uuid", "price_plan_uuid" ], "type": "object" }, "ServiceCustomBillingCheckModel": { "allOf": [ { "$ref": "#/definitions/ServiceBillingCheckModel" }, { "properties": { "config": { "description": "List of custom server hardware configurations.", "items": { "$ref": "#/definitions/ConfigCompactModel" }, "type": "array" }, "pay_currency": { "description": "Currency for billing payment.", "enum": [ "bonus", "main", "vk_rub" ], "example": "bonus", "type": "string" }, "template_service_uuid": { "description": "Template service identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "type": "object" } ] }, "ServiceCustomUpgradeBillingCheckModel": { "properties": { "config": { "description": "List of hardware configurations for the upgrade.", "items": { "$ref": "#/definitions/ConfigCompactModel" }, "type": "array" }, "resource_uuid": { "description": "Resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "resource_uuid" ], "type": "object" }, "ServicePlanAvailable": { "properties": { "count": { "description": "Number of available configurations for the plan.", "type": "integer" }, "plan_uuid": { "description": "Price plan identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "type": "object" }, "ServiceResourceAdditionalBillingCheckModel": { "properties": { "quantity": { "default": 1, "description": "Number of additional resource units.", "minimum": 1, "type": "integer" }, "resource_uuid": { "description": "Resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "resource_uuid" ], "type": "object" }, "ServiceResourceBillingCheckModel": { "properties": { "pay_day": { "description": "Day of the month for billing payment.", "maximum": 28, "minimum": 1, "type": "integer" }, "price_plan_uuid": { "description": "Price plan identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "resource_uuid": { "description": "Resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "price_plan_uuid", "resource_uuid" ], "type": "object" }, "ServiceTagCatalog": { "properties": { "is_filter": { "description": "Indicates whether the tag is used as a filter.", "type": "boolean" }, "is_hide": { "description": "Indicates whether the tag is hidden.", "type": "boolean" }, "name": { "description": "Name of the tag.", "type": "string" }, "sort_weight": { "description": "Sort weight for ordering tags.", "type": "integer" }, "style_key": { "description": "Style key for the tag appearance.", "type": "string" }, "text": { "description": "Display text of the tag.", "type": "string" }, "uuid": { "description": "Tag identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "is_filter", "is_hide", "name", "sort_weight", "style_key", "text", "uuid" ], "type": "object" }, "ServiceView": { "allOf": [ { "$ref": "#/definitions/ServiceBase" }, { "properties": { "addition": { "description": "List of additional services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "available": { "description": "List of available configurations per location.", "items": { "$ref": "#/definitions/ServiceAvailable" }, "type": "array" }, "eol_date": { "description": "End-of-life date as a Unix timestamp.", "type": "integer" }, "is_editable": { "description": "Indicates whether the service configuration is editable.", "type": "boolean" }, "is_order": { "description": "Indicates whether the service is available for ordering.", "type": "boolean" }, "is_preorder": { "description": "Indicates whether the service is available for pre-ordering.", "type": "boolean" }, "is_price_plan_discount_enabled": { "description": "Indicates whether the price plan discount is enabled.", "type": "boolean" }, "is_primary": { "description": "Indicates whether the service is primary.", "type": "boolean" }, "is_qchange": { "description": "Indicates whether the service supports quick change.", "type": "boolean" }, "is_single_prolonged": { "description": "Indicates whether the service has a single renewal period.", "type": "boolean" }, "is_user_discount_enabled": { "description": "Indicates whether the user discount is enabled.", "type": "boolean" }, "location_price_collection": { "allOf": [ { "$ref": "#/definitions/LocationPriceModelView" } ], "description": "Price collection per location." }, "model": { "description": "Service model type.", "type": "string" }, "name": { "description": "Name of the service.", "type": "string" }, "price_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Price collection for the service." }, "price_plan_available": { "description": "List of available price plan UUIDs.", "items": { "type": "string" }, "type": "array" }, "primary": { "description": "List of primary services.", "items": { "$ref": "#/definitions/ServiceBase" }, "type": "array" }, "quantity": { "description": "Quantity of service units.", "type": "integer" }, "service_tag": { "description": "Service tag identifier.", "type": "string" }, "setup_fee_collection": { "allOf": [ { "$ref": "#/definitions/PriceModel" } ], "description": "Setup fee price collection." }, "state": { "description": "Billing state of the service.", "type": "string" }, "tag_list": { "description": "List of tag objects assigned to the service.", "items": { "$ref": "#/definitions/ServiceTagCatalog" }, "type": "array" }, "tags": { "description": "List of tag names assigned to the service.", "items": { "type": "string" }, "type": "array" }, "tariff_line": { "description": "Billing option of the service.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "addition", "available", "is_order", "is_preorder", "is_price_plan_discount_enabled", "is_primary", "is_single_prolonged", "is_user_discount_enabled", "model", "name", "price_collection", "price_plan_available", "primary", "service_tag", "setup_fee_collection", "state", "tag_list", "tags", "tariff_line", "uuid" ], "type": "object" } ] }, "SpecialOfferDiscountCampaignDetailModel": { "properties": { "discount": { "description": "Discount percentage.", "type": "integer" }, "model": { "description": "Server model for the Auction Discount Campaign.", "type": "string" }, "name": { "description": "Name of the Auction Discount Campaign.", "type": "string" }, "service_uuids": { "description": "List of service identifiers.", "items": { "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "type": "array" }, "uuid": { "description": "Unique identifier for the Auction Discount Campaign.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "discount", "model", "name", "service_uuids", "uuid" ], "type": "object" }, "SpecialOfferDiscountCampaignResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/SpecialOfferDiscountCampaignDetailModel" } ], "description": "Special offer data." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "SubnetDetailModel": { "properties": { "broadcast": { "description": "Broadcast address.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "created": { "description": "Creation timestamp.", "type": "integer" }, "free": { "description": "Number of available IP addresses in the subnet.", "type": "integer" }, "gateway": { "description": "Gateway IP address.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "is_broken": { "description": "If true, subnet has configuration issues.", "type": "boolean" }, "is_full": { "description": "If true, subnet has no available IP addresses.", "type": "boolean" }, "is_master_shared": { "description": "If true, master subnet is shared.", "type": "boolean" }, "is_processing": { "description": "If true, network is currently being processed.", "type": "boolean" }, "is_use_vrrp": { "description": "If true, VRRP (Virtual Router Redundancy Protocol) is enabled.", "type": "boolean" }, "is_visible": { "description": "If true, subnet is visible to the user.", "type": "boolean" }, "location_uuid": { "description": "Location identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "master": { "description": "Master subnet in CIDR notation.", "example": "10.0.0.0/29", "maxLength": 43, "minLength": 8, "type": "string" }, "master_service_type": { "description": "Service type of the master subnet.", "enum": [ "shared", "dedicated", "alias", null ], "example": "shared", "type": [ "string", "null" ] }, "master_uuid": { "description": "Master subnet identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "netmask": { "description": "Network mask.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "network": { "description": "Network identifier.", "type": "integer" }, "network_telematics_type": { "enum": [ "HOSTING", "COLOCATION", "MIXED", "DATA_TRANSFER" ], "example": "HOSTING", "type": "string" }, "network_uuid": { "description": "Network identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "nexthop": { "description": "Next hop IP address for static routing.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "owner_id": { "description": "Owner identifier.", "type": "integer" }, "prefixlen": { "description": "Subnet prefix length.", "type": "integer" }, "reserved_vrrp_ip": { "description": "IPv4 addresses reserved for VRRP (minimum 0, maximum 2).", "items": { "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "maxItems": 2, "minItems": 0, "type": "array", "uniqueItems": true }, "resource_uuid": { "description": "Resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "subnet": { "description": "Subnet in CIDR notation.", "example": "10.0.0.0/29", "maxLength": 43, "minLength": 8, "type": "string" }, "subnet_type": { "description": "Type of the subnet.", "enum": [ "normal", "static", "vrrp", "alias" ], "example": "normal", "type": "string" }, "updated": { "description": "Last update timestamp.", "type": "integer" }, "usage": { "description": "Subnet usage percentage.", "type": "number" }, "used": { "description": "Number of used IP addresses in the subnet.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "version": { "description": "IP version (4 or 6).", "type": "integer" }, "vrrp": { "description": "VRRP IP address. DEPRECATED: use reserved_vrrp_ip instead.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "vrrp_in_location_allowed": { "description": "If true, VRRP is allowed in this location.", "type": "boolean" } }, "required": [ "created", "is_broken", "is_full", "is_master_shared", "is_processing", "is_visible", "location_uuid", "master_uuid", "network_uuid", "owner_id", "prefixlen", "resource_uuid", "subnet", "subnet_type", "updated", "uuid", "version", "vrrp_in_location_allowed" ], "type": "object" }, "SubnetDetailResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "allOf": [ { "$ref": "#/definitions/SubnetDetailModel" } ], "description": "Subnet object." }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "SubnetListModel": { "properties": { "broadcast": { "description": "Broadcast address.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "created": { "description": "Creation timestamp.", "type": "integer" }, "free": { "description": "Number of available IP addresses in the subnet.", "type": "integer" }, "gateway": { "description": "Gateway IP address.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "is_broken": { "description": "If true, subnet has configuration issues.", "type": "boolean" }, "is_full": { "description": "If true, subnet has no available IP addresses.", "type": "boolean" }, "is_master_shared": { "description": "If true, master subnet is shared.", "type": "boolean" }, "is_processing": { "description": "If true, network is currently being processed.", "type": "boolean" }, "is_use_vrrp": { "description": "If true, VRRP (Virtual Router Redundancy Protocol) is enabled.", "type": "boolean" }, "is_visible": { "description": "If true, subnet is visible to the user.", "type": "boolean" }, "location_uuid": { "description": "Location identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "master": { "description": "Master subnet in CIDR notation.", "example": "10.0.0.0/29", "maxLength": 43, "minLength": 8, "type": "string" }, "master_service_type": { "description": "Service type of the master subnet.", "enum": [ "shared", "dedicated", "alias", null ], "example": "shared", "type": [ "string", "null" ] }, "master_uuid": { "description": "Master subnet identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "netmask": { "description": "Network mask.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "network": { "description": "Network identifier.", "type": "integer" }, "network_telematics_type": { "enum": [ "HOSTING", "COLOCATION", "MIXED", "DATA_TRANSFER" ], "example": "HOSTING", "type": "string" }, "network_uuid": { "description": "Network identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "nexthop": { "description": "Next hop IP address for static routing.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "owner_id": { "description": "Owner identifier.", "type": "integer" }, "prefixlen": { "description": "Subnet prefix length.", "type": "integer" }, "reserved_vrrp_ip": { "description": "IPv4 addresses reserved for VRRP (minimum 0, maximum 2).", "items": { "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "maxItems": 2, "minItems": 0, "type": "array", "uniqueItems": true }, "resource_uuid": { "description": "Resource identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "subnet": { "description": "Subnet in CIDR notation.", "example": "10.0.0.0/29", "maxLength": 43, "minLength": 8, "type": "string" }, "subnet_type": { "description": "Type of the subnet.", "enum": [ "normal", "static", "vrrp", "alias" ], "example": "normal", "type": "string" }, "updated": { "description": "Last update timestamp.", "type": "integer" }, "usage": { "description": "Subnet usage percentage.", "type": "number" }, "used": { "description": "Number of used IP addresses in the subnet.", "type": "integer" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" }, "version": { "description": "IP version (4 or 6).", "type": "integer" }, "vrrp": { "description": "VRRP IP address. DEPRECATED: use reserved_vrrp_ip instead.", "example": "10.0.64.11", "maxLength": 43, "minLength": 6, "type": "string" }, "vrrp_in_location_allowed": { "description": "If true, VRRP is allowed in this location.", "type": "boolean" } }, "required": [ "created", "is_broken", "is_full", "is_master_shared", "is_processing", "is_visible", "location_uuid", "master_uuid", "network_uuid", "owner_id", "prefixlen", "resource_uuid", "subnet", "subnet_type", "updated", "uuid", "version", "vrrp_in_location_allowed" ], "type": "object" }, "SubnetListResultModel": { "properties": { "execution_time": { "type": "number" }, "item_count": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "progress": { "type": "integer" }, "result": { "description": "List of master subnets.", "items": { "$ref": "#/definitions/SubnetListModel" }, "type": "array" }, "status": { "type": "string" }, "task_id": { "description": "Task identifier.", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "task_id" ], "type": "object" }, "SubnetSetVRRPModel": { "properties": { "reserved_vrrp_ip": { "description": "Two IPv4 addresses reserved for VRRP (exactly 2 required).", "items": { "example": "10.0.0.0", "maxLength": 43, "minLength": 6, "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array", "uniqueItems": true } }, "type": "object" }, "TagBase": { "properties": { "default": { "description": "Indicates whether this is a default tag.", "type": "boolean" }, "tag": { "description": "Tag value.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "tag", "uuid" ], "type": "object" }, "TrafficConsumptionMessage": { "properties": { "consumption_type": { "description": "Type of consumption limit.", "enum": [ "speed", "traff" ], "example": "speed", "type": "string" }, "traffic_spent": { "description": "Amount of traffic spent in the selected month, in GB (Gigabytes, 10^9 bytes).", "type": "integer" } }, "required": [ "consumption_type", "traffic_spent" ], "type": "object" }, "UpgradeBillingModel": { "properties": { "currency": { "description": "Billing currency code.", "type": "string" }, "current_price_plan": { "allOf": [ { "$ref": "#/definitions/PricePlanModel" } ], "description": "Currently active price plan." }, "has_enough_balance": { "description": "If true, account has sufficient balance.", "type": "boolean" }, "next_price_plan": { "allOf": [ { "$ref": "#/definitions/PricePlanModel" } ], "description": "Next scheduled price plan." }, "price": { "allOf": [ { "$ref": "#/definitions/UpgradeNextPriceModel" } ], "description": "Upgrade price details." } }, "required": [ "currency", "current_price_plan", "next_price_plan" ], "type": "object" }, "UpgradeNextPriceModel": { "properties": { "amount_due": { "description": "Amount due for payment.", "type": "number" }, "debt": { "description": "Current debt amount.", "type": "number" }, "discount": { "description": "Total discount percentage.", "maximum": 99, "minimum": 0, "type": "integer" }, "discount_detail": { "allOf": [ { "$ref": "#/definitions/DiscountDetailModel" } ], "description": "Detailed discount breakdown." }, "due_date": { "description": "Timestamp of the end of the current billing period.", "type": "integer" }, "future_amount_due": { "description": "Future amount due after the upgrade.", "type": "number" }, "future_price": { "description": "Resource price with discount applied for the entire duration of the next price plan (same as plan_price if current and next plans are identical).", "type": "number" }, "paid_till": { "description": "Timestamp until which the resource was paid for.", "type": "integer" }, "plan_price": { "description": "Resource price with discount applied for the entire duration of the current price plan.", "type": "number" }, "setup_fee": { "description": "Setup fee amount.", "type": "integer" }, "upgrade_price": { "description": "Price of the upgrade.", "type": "number" } }, "required": [ "amount_due", "debt", "discount", "discount_detail", "future_amount_due", "future_price", "plan_price", "setup_fee", "upgrade_price" ], "type": "object" }, "UserNameAdd": { "properties": { "name": { "description": "User name value.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "UserNameBase": { "properties": { "name": { "description": "User name value.", "type": "string" }, "uuid": { "description": "Universally unique identifier (UUID).", "example": "00000000-0000-0000-A000-000000000000", "maxLength": 36, "minLength": 36, "type": "string" } }, "required": [ "name", "uuid" ], "type": "object" }, "UserNameUpdate": { "properties": { "name": { "description": "User name value.", "type": "string" } }, "required": [ "name" ], "type": "object" } }, "info": { "description": "Managing dedicated servers: creating and configuring resources, managing billing, controlling power, installing OS, setting up network, and more.", "title": "Dedicated Servers API", "version": "v 2.0.0" }, "paths": { "/block_storage/access": { "get": { "description": "Returns the value of the block storage beta flag.", "operationId": "get_block_storage_flag_view", "responses": { "200": { "description": "Block storage beta flag value has been returned.", "schema": { "$ref": "#/definitions/ResponseBlockStorageBetaFlag" } } }, "summary": "Get block storage flag value", "tags": [ "Block Storage Manager" ] } }, "/boot/device/{resource_uuid}": { "get": { "description": "Returns the server boot device details.", "operationId": "get_device_view", "responses": { "200": { "description": "Server boot device has been returned.", "schema": { "$ref": "#/definitions/ResponseDevice" } } }, "summary": "Get server boot details", "tags": [ "Boot Manager" ] }, "parameters": [ { "in": "path", "name": "resource_uuid", "required": true, "type": "string" } ], "post": { "description": "Sets the server boot template.", "operationId": "post_device_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/DeviceSet" } } ], "responses": { "200": { "description": "Server boot template has been set.", "schema": { "$ref": "#/definitions/ResponseDevice" } }, "202": { "description": "Task for setting boot device has been queued.", "schema": { "$ref": "#/definitions/ResponseDevice" } } }, "summary": "Set server boot template", "tags": [ "Boot Manager" ] } }, "/boot/os/{resource_uuid}": { "get": { "description": "Returns the server operating system configuration details.", "operationId": "get_os_view", "responses": { "200": { "description": "Operating system configuration has been returned.", "schema": { "$ref": "#/definitions/ResponseOSConfig" } } }, "summary": "Get server OS details", "tags": [ "Boot Manager" ] }, "parameters": [ { "in": "path", "name": "resource_uuid", "required": true, "type": "string" } ], "patch": { "description": "Reinstalls the operating system using the current configuration.", "operationId": "patch_os_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ReinstallInput" } } ], "responses": { "200": { "description": "Operating system has been reinstalled.", "schema": { "$ref": "#/definitions/ResponseOSConfig" } }, "202": { "description": "Task for reinstalling operating system has been queued.", "schema": { "$ref": "#/definitions/ResponseOSConfig" } } }, "summary": "Reinstall OS", "tags": [ "Boot Manager" ] }, "post": { "description": "Installs a new operating system configuration on the server.", "operationId": "post_os_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/OSConfigInput" } } ], "responses": { "200": { "description": "Operating system configuration has been installed.", "schema": { "$ref": "#/definitions/ResponseOSConfig" } } }, "summary": "Install server OS configuration", "tags": [ "Boot Manager" ] } }, "/boot/os/{resource_uuid}/password": { "get": { "description": "Returns the server operating system password.", "operationId": "get_os_password_view", "responses": { "200": { "description": "Operating system password has been returned.", "schema": { "$ref": "#/definitions/ResponseOSPassword" } } }, "summary": "Get server OS password", "tags": [ "Boot Manager" ] }, "parameters": [ { "in": "path", "name": "resource_uuid", "required": true, "type": "string" } ] }, "/boot/partitions/local_drives": { "get": { "description": "Returns available local disks for partition configuration.", "operationId": "get_partitions_local_drives_get_view", "parameters": [ { "description": "Service unique identifier (UUID).", "in": "query", "name": "service_uuid", "type": "string" }, { "description": "Resource unique identifier (UUID).", "in": "query", "name": "resource_uuid", "type": "string" } ], "responses": { "200": { "description": "List of available local disks for partition configuration.", "schema": { "$ref": "#/definitions/PartitionsLocalDisksResponse" } } }, "summary": "List local disks for partition configuration", "tags": [ "Boot Manager" ] }, "post": { "description": "Returns available local disks for custom server order.", "operationId": "post_partitions_local_drives_get_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/PartitionsLocalDiskInput" } }, { "description": "Service unique identifier (UUID).", "in": "query", "name": "service_uuid", "type": "string" }, { "description": "Resource unique identifier (UUID).", "in": "query", "name": "resource_uuid", "type": "string" } ], "responses": { "200": { "description": "List of available local disks for custom server order.", "schema": { "$ref": "#/definitions/PartitionsLocalDisksResponse" } } }, "summary": "Get local disks for custom server order", "tags": [ "Boot Manager" ] } }, "/boot/partitions/validate": { "post": { "description": "Validates the partitions configuration for the operating system.", "operationId": "post_partitions_validate_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/PartitionsValidate" } }, { "description": "Service unique identifier (UUID).", "in": "query", "name": "service_uuid", "type": "string" }, { "description": "Resource unique identifier (UUID).", "in": "query", "name": "resource_uuid", "type": "string" } ], "responses": { "200": { "description": "Partitions configuration has been validated.", "schema": { "$ref": "#/definitions/PartitionsValidateResponse" } } }, "summary": "Validate partitions config for OS", "tags": [ "Boot Manager" ] } }, "/boot/template/custom_os_image": { "get": { "operationId": "get_custom_os_image_list_view", "parameters": [ { "description": "Search by UUID, `version_name`, or `family_type`.", "in": "query", "name": "search", "type": "string" } ], "responses": { "200": { "description": "Returns a list of custom OS images.", "schema": { "$ref": "#/definitions/CustomOSImageListResponse" } } }, "summary": "List custom OS images", "tags": [ "Boot Manager" ] }, "post": { "operationId": "post_custom_os_image_list_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/CustomOSImageCreateModel" } } ], "responses": { "201": { "description": "Returns created custom OS image.", "schema": { "$ref": "#/definitions/CustomOSImageDetailResponse" } } }, "summary": "Create new custom OS image", "tags": [ "Boot Manager" ] } }, "/boot/template/custom_os_image/{uuid}": { "delete": { "operationId": "delete_custom_os_image_detail_view", "responses": { "200": { "description": "Returns deleted custom OS image.", "schema": { "$ref": "#/definitions/CustomOSImageDetailModel" } } }, "summary": "Delete custom OS image", "tags": [ "Boot Manager" ] }, "get": { "operationId": "get_custom_os_image_detail_view", "responses": { "200": { "description": "Returns Custom OS Image.", "schema": { "$ref": "#/definitions/CustomOSImageDetailResponse" } } }, "summary": "Get custom OS image", "tags": [ "Boot Manager" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "operationId": "put_custom_os_image_detail_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/CustomOSImageUpdateModel" } } ], "responses": { "200": { "description": "Returns updated custom OS Image.", "schema": { "$ref": "#/definitions/CustomOSImageDetailResponse" } } }, "summary": "Update custom OS image", "tags": [ "Boot Manager" ] } }, "/boot/template/device": { "get": { "description": "Returns a list of available boot device templates.", "operationId": "get_device_template_list_view", "parameters": [ { "description": "Service unique identifier (UUID) used to filter available device templates.", "in": "query", "name": "service_uuid", "type": "string" } ], "responses": { "200": { "description": "List of available boot device templates.", "schema": { "$ref": "#/definitions/ResponseDeviceInfoList" } } }, "summary": "List boot templates", "tags": [ "Boot Manager" ] } }, "/boot/template/os": { "get": { "description": "Returns a list of available operating system templates.", "operationId": "get_os_template_list_view", "parameters": [ { "description": "Location unique identifier (UUID) used to filter available operating system templates.", "in": "query", "name": "location_uuid", "type": "string" }, { "description": "Service unique identifier (UUID) used to filter available operating system templates.", "in": "query", "name": "service_uuid", "type": "string" } ], "responses": { "200": { "description": "List of operating system templates.", "schema": { "$ref": "#/definitions/ResponseOSTemplateList" } } }, "summary": "List OS configurations", "tags": [ "Boot Manager" ] } }, "/boot/template/os/new": { "get": { "description": "Returns a list of available operating system templates.", "operationId": "get_os_template_list_new_view", "parameters": [ { "description": "Location unique identifier (UUID) used to filter available operating system templates.", "in": "query", "name": "location_uuid", "type": "string" }, { "description": "Service unique identifier (UUID) used to filter available operating system templates.", "in": "query", "name": "service_uuid", "type": "string" } ], "responses": { "200": { "description": "List of operating system templates.", "schema": { "$ref": "#/definitions/OSTemplateListNewResponse" } } }, "summary": "List OS configurations", "tags": [ "Boot Manager" ] } }, "/consumption/speed/location/{location_id}": { "parameters": [ { "in": "path", "name": "location_id", "required": true, "type": "integer" } ] }, "/consumption/speed/network/{network_uuid}": { "parameters": [ { "in": "path", "name": "network_uuid", "required": true, "type": "string" } ] }, "/consumption/speed/protected/{protected_uuid}": { "parameters": [ { "in": "path", "name": "protected_uuid", "required": true, "type": "string" } ] }, "/consumption/speed/resource/{resource_uuid}": { "get": { "operationId": "get_graph_resource_view", "parameters": [ { "default": "false", "description": "If true, shows local port type.", "enum": [ "true", "false" ], "in": "query", "name": "local", "type": "string" }, { "default": "min5", "description": "Interval to group points by.", "enum": [ "min5", "hour" ], "in": "query", "name": "interval", "type": "string" }, { "default": 1787054319, "description": "End time for speed points range, Unix timestamp.", "in": "query", "name": "till", "type": "integer" }, { "default": 1787050719, "description": "Start time for speed points range, Unix timestamp.", "in": "query", "name": "from", "type": "integer" } ], "responses": { "200": { "description": "List of speed points.", "schema": { "$ref": "#/definitions/ResponseSpeedGraph" } } }, "summary": "Get resource speed points", "tags": [ "Consumption" ] }, "parameters": [ { "in": "path", "name": "resource_uuid", "required": true, "type": "string" } ] }, "/consumption/traffic/resource/{resource_uuid}": { "get": { "operationId": "get_traffic_resource_view", "parameters": [ { "default": 8, "description": "Month for which traffic will be calculated.", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "in": "query", "name": "month", "type": "integer" } ], "responses": { "200": { "description": "Traffic consumption data has been returned.", "schema": { "$ref": "#/definitions/ResponseTrafficConsumption" } } }, "summary": "Get traffic consumption", "tags": [ "Consumption" ] }, "parameters": [ { "in": "path", "name": "resource_uuid", "required": true, "type": "string" } ] }, "/dashboard/health": { "get": { "description": "Returns API health information.", "operationId": "get_health_info_view", "responses": { "200": { "description": "API health information has been returned.", "schema": { "$ref": "#/definitions/HealthInfoResponse" } } }, "summary": "Get API info", "tags": [ "Dashboard" ] } }, "/dashboard/maintenance": { "get": { "description": "Returns the current maintenance status.", "operationId": "get_maintenance_view", "responses": { "200": { "description": "Maintenance status has been returned.", "schema": { "$ref": "#/definitions/MaintenanceStatusResponse" } } }, "summary": "Get maintenance status", "tags": [ "Dashboard" ] } }, "/dashboard/task": { "get": { "description": "Returns a list of currently active tasks.", "operationId": "get_active_task_view", "responses": { "200": { "description": "List of active tasks.", "schema": { "$ref": "#/definitions/ResultActiveTasks" } } }, "summary": "List active tasks", "tags": [ "Dashboard" ] } }, "/event": { "get": { "description": "Returns a list of events.", "operationId": "get_event_manager", "parameters": [ { "description": "Action name.", "in": "query", "name": "action_name", "type": "string" }, { "description": "Item name.", "in": "query", "name": "item_name", "type": "string" }, { "description": "Item unique identifier.", "in": "query", "name": "item_uuid", "type": "string" }, { "description": "Request unique identifier.", "in": "query", "name": "request_uuid", "type": "string" }, { "description": "Items per page.", "in": "query", "name": "limit", "type": "integer" }, { "description": "Page number.", "in": "query", "name": "page", "type": "integer" } ], "responses": { "200": { "description": "List of events.", "schema": { "$ref": "#/definitions/EventResultListModel" } }, "303": { "description": "Async result has been returned.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "List events", "tags": [ "Events" ] } }, "/location": { "get": { "operationId": "get_location_view", "responses": { "200": { "description": "Returns list of Location", "schema": { "$ref": "#/definitions/LocationResultListModel" } } }, "summary": "List locations", "tags": [ "Locations" ] } }, "/location/{uuid}": { "get": { "operationId": "get_location_get_view", "responses": { "200": { "description": "Returns Location", "schema": { "$ref": "#/definitions/LocationResultModel" } } }, "summary": "Show location info", "tags": [ "Locations" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/misc/name-service/name": { "get": { "operationId": "get_name_view", "parameters": [ { "collectionFormat": "multi", "description": "Tags to filter names by.", "in": "query", "items": { "type": "string" }, "name": "tags", "type": "array" }, { "default": 10, "description": "Number of items per page.", "in": "query", "name": "limit", "type": "integer" }, { "default": 1, "description": "Page number for pagination.", "in": "query", "name": "page", "type": "integer" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" } ], "responses": { "200": { "description": "List of names.", "schema": { "$ref": "#/definitions/ResponseNameListModel" } } }, "summary": "List names", "tags": [ "Miscellaneous" ] } }, "/misc/name-service/name/{uuid}": { "get": { "operationId": "get_name_update_view", "responses": { "200": { "description": "Name has been returned.", "schema": { "$ref": "#/definitions/ResponseNameResult" } } }, "summary": "Get name", "tags": [ "Miscellaneous" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/misc/name-service/name/{uuid}/tag": { "get": { "operationId": "get_name_tags_view", "responses": { "200": { "description": "List of tags associated with the name.", "schema": { "$ref": "#/definitions/ResponseNameTagsListResult" } } }, "summary": "List name tags", "tags": [ "Miscellaneous" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/misc/name-service/random": { "get": { "operationId": "get_random_name_view", "parameters": [ { "default": false, "description": "If true, returns one of user's names.", "in": "query", "name": "get_user_name", "type": "boolean" }, { "collectionFormat": "multi", "description": "Tags to filter names by.", "in": "query", "items": { "type": "string" }, "name": "tags", "type": "array" } ], "responses": { "200": { "description": "Random name has been returned.", "schema": { "$ref": "#/definitions/ResponseNameResult" } } }, "summary": "Get random name", "tags": [ "Miscellaneous" ] } }, "/misc/name-service/tag": { "get": { "operationId": "get_tag_view", "parameters": [ { "default": 10, "description": "Number of items per page.", "in": "query", "name": "limit", "type": "integer" }, { "default": 1, "description": "Page number for pagination.", "in": "query", "name": "page", "type": "integer" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" } ], "responses": { "200": { "description": "List of tags.", "schema": { "$ref": "#/definitions/ResponseTagListResult" } } }, "summary": "List tags", "tags": [ "Miscellaneous" ] } }, "/misc/name-service/tag/{uuid}": { "get": { "operationId": "get_tag_update_view", "responses": { "200": { "description": "Tag has been returned.", "schema": { "$ref": "#/definitions/ResponseTagResult" } } }, "summary": "Get tag", "tags": [ "Miscellaneous" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/misc/name-service/tag/{uuid}/name": { "get": { "operationId": "get_tag_names_view", "responses": { "200": { "description": "List of names associated with the tag.", "schema": { "$ref": "#/definitions/ResponseTagNamesListResult" } } }, "summary": "List tag names", "tags": [ "Miscellaneous" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/misc/user-name-service/name": { "get": { "operationId": "get_user_name_view", "parameters": [ { "default": 10, "description": "Number of items per page.", "in": "query", "name": "limit", "type": "integer" }, { "default": 1, "description": "Page number for pagination.", "in": "query", "name": "page", "type": "integer" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" } ], "responses": { "200": { "description": "List of user names.", "schema": { "$ref": "#/definitions/ResponseUserNameListResult" } } }, "summary": "List user names", "tags": [ "Miscellaneous" ] }, "post": { "operationId": "post_user_name_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/UserNameAdd" } } ], "responses": { "201": { "description": "User name has been created.", "schema": { "$ref": "#/definitions/ResponseUserNameResult" } } }, "summary": "Create user name", "tags": [ "Miscellaneous" ] } }, "/misc/user-name-service/name/{uuid}": { "delete": { "operationId": "delete_user_name_update_view", "responses": { "200": { "description": "User name has been deleted.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Delete user name", "tags": [ "Miscellaneous" ] }, "get": { "operationId": "get_user_name_update_view", "responses": { "200": { "description": "User name has been returned.", "schema": { "$ref": "#/definitions/ResponseUserNameResult" } } }, "summary": "Get user name", "tags": [ "Miscellaneous" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "operationId": "put_user_name_update_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/UserNameUpdate" } } ], "responses": { "200": { "description": "User name has been updated.", "schema": { "$ref": "#/definitions/ResponseUserNameResult" } } }, "summary": "Update user name", "tags": [ "Miscellaneous" ] } }, "/network": { "get": { "description": "Returns a list of networks with optional filtering by resource, location, or shared status.", "operationId": "get_network_view", "parameters": [ { "description": "If true, filters shared networks.", "in": "query", "name": "is_shared", "type": "boolean" }, { "description": "Universally unique identifier (UUID) of the location to filter networks.", "in": "query", "name": "location_uuid", "type": "string" }, { "description": "Universally unique identifier (UUID) of the resource. Filters networks that have IP addresses allocated for the specified resource.", "in": "query", "name": "resource_uuid", "type": "string" }, { "description": "Limit of results per pagination page.", "in": "query", "name": "limit", "type": "integer" }, { "description": "Pagination page number.", "in": "query", "name": "page", "type": "integer" } ], "responses": { "200": { "description": "List of networks.", "schema": { "$ref": "#/definitions/NetworkListResultModel" } } }, "summary": "List networks", "tags": [ "Network Management API" ] } }, "/network/ipam/ip": { "get": { "description": "Returns a list of IP addresses with optional filtering by location, subnet, network, owner, or shared status.", "operationId": "get_ip_list_view", "parameters": [ { "description": "If true, filters IP addresses only from shared networks, otherwise filters only from dedicated networks.", "in": "query", "name": "is_shared", "type": "boolean" }, { "description": "Owner identifier to filter IP addresses.", "in": "query", "name": "owner_id", "type": "integer" }, { "description": "Universally unique identifier (UUID) of the network to filter IP addresses.", "in": "query", "name": "network_uuid", "type": "string" }, { "description": "Universally unique identifier (UUID) of the subnet to filter IP addresses.", "in": "query", "name": "subnet_uuid", "type": "string" }, { "description": "Universally unique identifier (UUID) of the location to filter IP addresses.", "in": "query", "name": "location_uuid", "type": "string" }, { "description": "Limit of results per pagination page.", "in": "query", "name": "limit", "type": "integer" }, { "description": "Pagination page number.", "in": "query", "name": "page", "type": "integer" } ], "responses": { "200": { "description": "List of IP addresses.", "schema": { "$ref": "#/definitions/IpResultListModel" } } }, "summary": "List IP addresses", "tags": [ "Network Management API" ] } }, "/network/ipam/ip/{uuid}": { "delete": { "description": "Releases the specified IP address from the subnet.", "operationId": "delete_ip_detail_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/IpReleaseModel" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Release IP address", "tags": [ "Network Management API" ] }, "get": { "description": "Returns information about the specified IP address.", "operationId": "get_ip_detail_view", "responses": { "200": { "description": "IP address has been returned.", "schema": { "$ref": "#/definitions/IpResultModel" } } }, "summary": "Get IP address", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/network/ipam/local_ip": { "get": { "description": "Returns a list of local IP addresses with optional filtering by location, subnet, or network.", "operationId": "get_local_ip_list_view", "parameters": [ { "description": "Universally unique identifier (UUID) of the network to filter local IP addresses.", "in": "query", "name": "network_uuid", "type": "string" }, { "description": "Universally unique identifier (UUID) of the subnet to filter local IP addresses.", "in": "query", "name": "subnet_uuid", "type": "string" }, { "description": "Universally unique identifier (UUID) of the location to filter local IP addresses.", "in": "query", "name": "location_uuid", "type": "string" }, { "description": "Limit of results per pagination page.", "in": "query", "name": "limit", "type": "integer" }, { "description": "Pagination page number.", "in": "query", "name": "page", "type": "integer" } ], "responses": { "200": { "description": "List of local IP addresses.", "schema": { "$ref": "#/definitions/LocalIpResultListModel" } } }, "summary": "List local IP addresses", "tags": [ "Network Management API" ] } }, "/network/ipam/local_ip/{uuid}": { "delete": { "description": "Releases the specified local IP address from the subnet.", "operationId": "delete_local_ip_detail_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/LocalIpReleaseModel" } } ], "responses": { "200": { "description": "Local IP address has been released." } }, "summary": "Release local IP address", "tags": [ "Network Management API" ] }, "get": { "description": "Returns information about the specified local IP address.", "operationId": "get_local_ip_detail_view", "responses": { "200": { "description": "Local IP address has been returned.", "schema": { "$ref": "#/definitions/LocalIpResultModel" } } }, "summary": "Get local IP address", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/network/ipam/local_subnet": { "get": { "description": "Returns a list of local subnets.", "operationId": "get_local_subnet_view", "responses": { "200": { "description": "List of local subnets.", "schema": { "$ref": "#/definitions/SubnetListResultModel" } } }, "summary": "List local subnets", "tags": [ "Network Management API" ] }, "post": { "description": "Creates a new local subnet.", "operationId": "post_local_subnet_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/LocalSubnetCreateModel" } } ], "responses": { "201": { "description": "Local subnet has been created.", "schema": { "$ref": "#/definitions/LocalSubnetDetailResultModel" } } }, "summary": "Create local subnet", "tags": [ "Network Management API" ] } }, "/network/ipam/local_subnet/{subnet_uuid}/local_ip": { "get": { "description": "Returns a list of local IP addresses in the specified subnet.", "operationId": "get_subnet_local_ip_view", "responses": { "200": { "description": "List of local IP addresses.", "schema": { "$ref": "#/definitions/LocalIpResultListModel" } } }, "summary": "List local IP addresses in subnet", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "subnet_uuid", "required": true, "type": "string" } ], "post": { "description": "Allocates a new local IP address in the specified subnet.", "operationId": "post_subnet_local_ip_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/LocalIpAllocateModel" } } ], "responses": { "201": { "description": "Local IP address has been allocated.", "schema": { "$ref": "#/definitions/LocalIpResultModel" } } }, "summary": "Allocate local IP address", "tags": [ "Network Management API" ] } }, "/network/ipam/local_subnet/{uuid}": { "delete": { "description": "Releases the specified local subnet.", "operationId": "delete_local_subnet_detail_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/LocalSubnetRemoveModel" } } ], "responses": { "200": { "description": "Local subnet has been released." } }, "summary": "Release local subnet", "tags": [ "Network Management API" ] }, "get": { "description": "Returns information about the specified local subnet.", "operationId": "get_local_subnet_detail_view", "responses": { "200": { "description": "Local subnet has been returned.", "schema": { "$ref": "#/definitions/LocalSubnetDetailResultModel" } } }, "summary": "Get local subnet", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/network/ipam/subnet": { "get": { "description": "Returns a list of master subnets.", "operationId": "get_subnet_view", "parameters": [ { "description": "Returns subnets filtered by network telematics type.", "in": "query", "name": "network_telematics_type", "type": "string" } ], "responses": { "200": { "description": "List of master subnets.", "schema": { "$ref": "#/definitions/SubnetListResultModel" } } }, "summary": "List master subnets", "tags": [ "Network Management API" ] } }, "/network/ipam/subnet/{subnet_uuid}/ip": { "get": { "description": "Returns a list of IP addresses in the specified subnet.", "operationId": "get_ip_view", "responses": { "200": { "description": "List of IP addresses.", "schema": { "$ref": "#/definitions/IpResultListModel" } } }, "summary": "List IP addresses in subnet", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "subnet_uuid", "required": true, "type": "string" } ], "post": { "description": "Allocates a new IP address in the specified subnet.", "operationId": "post_ip_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/IpAllocateModel" } } ], "responses": { "201": { "description": "IP address has been allocated.", "schema": { "$ref": "#/definitions/IpResultModel" } } }, "summary": "Allocate IP address", "tags": [ "Network Management API" ] } }, "/network/ipam/subnet/{uuid}": { "get": { "description": "Returns information about the specified subnet.", "operationId": "get_subnet_detail_view", "responses": { "200": { "description": "Subnet has been returned.", "schema": { "$ref": "#/definitions/SubnetDetailResultModel" } } }, "summary": "Get subnet", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/network/ipam/subnet/{uuid}/vrrp": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "description": "Sets reserved VRRP addresses for the specified subnet.", "operationId": "put_subnet_set_vrrp_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/SubnetSetVRRPModel" } } ], "responses": { "200": { "description": "VRRP addresses have been set for the subnet.", "schema": { "$ref": "#/definitions/SubnetDetailResultModel" } } }, "summary": "Set reserved VRRP addresses", "tags": [ "Network Management API" ] } }, "/network/limit/type": { "get": { "description": "Returns a list of available network limit types.", "operationId": "get_network_limit_type_view", "responses": { "200": { "description": "List of network limit types.", "schema": { "$ref": "#/definitions/NetworkLimitTypeResultListModel" } } }, "summary": "List network limit types", "tags": [ "Network Management API" ] } }, "/network/limit/{uuid}": { "get": { "description": "Returns network limit information for the specified resource.", "operationId": "get_network_limit_view", "responses": { "200": { "description": "Network limit has been returned.", "schema": { "$ref": "#/definitions/NetworkLimitResultModel" } } }, "summary": "Get network limit", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "description": "Updates network limit for the specified resource.", "operationId": "put_network_limit_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/NetworkLimitUpdateModel" } } ], "responses": { "201": { "description": "Network limit has been updated.", "schema": { "$ref": "#/definitions/NetworkLimitResultModel" } } }, "summary": "Update network limit", "tags": [ "Network Management API" ] } }, "/network/port": { "get": { "description": "Returns a list of ports.", "operationId": "get_port_view", "responses": { "200": { "description": "List of ports.", "schema": { "$ref": "#/definitions/PortResultModel" } } }, "summary": "List ports", "tags": [ "Network Management API" ] } }, "/network/port/hw/{hw_uuid}": { "get": { "description": "Returns ports associated with the specified hardware.", "operationId": "get_port_hw_view", "responses": { "200": { "description": "List of ports.", "schema": { "$ref": "#/definitions/PortResultModel" } } }, "summary": "List ports for hardware", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "hw_uuid", "required": true, "type": "string" } ] }, "/network/port/{uuid}": { "get": { "description": "Returns information about the specified port.", "operationId": "get_port_detail_view", "responses": { "200": { "description": "Port has been returned.", "schema": { "$ref": "#/definitions/PortResultModel" } } }, "summary": "Get port", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "description": "Applies network configuration to the specified port.", "operationId": "put_port_detail_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/PortApplyNetworkModel" } } ], "responses": { "200": { "description": "Port configuration has been applied.", "schema": { "$ref": "#/definitions/PortResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Apply port configuration", "tags": [ "Network Management API" ] } }, "/network/port/{uuid}/network": { "get": { "description": "Returns networks associated with the specified port.", "operationId": "get_port_manager_view", "responses": { "200": { "description": "List of networks.", "schema": { "$ref": "#/definitions/NetworkListResultModel" } } }, "summary": "List networks for port", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/network/{uuid}": { "get": { "description": "Returns information about the specified network.", "operationId": "get_network_detail_view", "responses": { "200": { "description": "Network has been returned.", "schema": { "$ref": "#/definitions/NetworkResultModel" } } }, "summary": "Get network", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "description": "Updates the specified network configuration.", "operationId": "put_network_detail_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/NetworkUpdateModel" } } ], "responses": { "200": { "description": "Network has been updated.", "schema": { "$ref": "#/definitions/NetworkResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Update network", "tags": [ "Network Management API" ] } }, "/network/{uuid}/basic_firewall": { "delete": { "description": "Removes all basic firewall rules from the specified network.", "operationId": "delete_network_basic_firewall_view", "responses": { "200": { "description": "All basic firewall rules have been removed from the network.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Remove all basic firewall rules from network", "tags": [ "Network Management API" ] }, "get": { "description": "Returns basic firewall rules for the specified network.", "operationId": "get_network_basic_firewall_view", "responses": { "200": { "description": "Network basic firewall rules have been returned.", "schema": { "$ref": "#/definitions/NetworkBasicFirewallResultModel" } } }, "summary": "Get network basic firewall rules", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "post": { "description": "Applies basic firewall rules to the specified network.", "operationId": "post_network_basic_firewall_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/NetworkBasicFirewallAddModel" } } ], "responses": { "200": { "description": "Basic firewall rules have been applied to the network.", "schema": { "$ref": "#/definitions/NetworkBasicFirewallResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Apply basic firewall rules to network", "tags": [ "Network Management API" ] } }, "/network/{uuid}/subnet": { "delete": { "description": "Removes a subnet from the specified network.", "operationId": "delete_network_subnet_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/NetworkReleaseSubnetModel" } } ], "responses": { "200": { "description": "Subnet has been removed from the network.", "schema": { "$ref": "#/definitions/NetworkResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Remove subnet from network", "tags": [ "Network Management API" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "post": { "description": "Adds a subnet to the specified network.", "operationId": "post_network_subnet_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/NetworkAddSubnetModel" } } ], "responses": { "201": { "description": "Subnet has been added to the network.", "schema": { "$ref": "#/definitions/NetworkResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Add subnet to network", "tags": [ "Network Management API" ] } }, "/plan": { "get": { "description": "Returns a list of price plans.", "operationId": "get_price_plan_view", "responses": { "200": { "description": "List of price plans.", "schema": { "$ref": "#/definitions/PricePlanResultListModel" } } }, "summary": "List price plans", "tags": [ "Price Plans" ] } }, "/plan/{uuid}": { "get": { "description": "Returns a price plan.", "operationId": "get_price_plan_get_view", "responses": { "200": { "description": "Price plan has been returned.", "schema": { "$ref": "#/definitions/PricePlanResultModel" } } }, "summary": "Get price plan", "tags": [ "Price Plans" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/power/{resource_uuid}": { "get": { "description": "Returns the resource power state.", "operationId": "get_resource_power_view", "responses": { "200": { "description": "Resource power state has been returned.", "schema": { "$ref": "#/definitions/ResponsePowerStatus" } } }, "summary": "Get server power state", "tags": [ "Power Manager" ] }, "parameters": [ { "in": "path", "name": "resource_uuid", "required": true, "type": "string" } ], "put": { "description": "Switches the resource power state.", "operationId": "put_resource_power_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/PowerSwitchStatus" } } ], "responses": { "200": { "description": "Resource power state has been switched.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Set server power state", "tags": [ "Power Manager" ] } }, "/power/{resource_uuid}/console": { "get": { "description": "Returns the resource console.", "operationId": "get_resource_console_view", "responses": { "200": { "description": "Resource console has been returned.", "schema": { "$ref": "#/definitions/ResponseConsole" } } }, "summary": "Get server console", "tags": [ "Power Manager" ] }, "parameters": [ { "in": "path", "name": "resource_uuid", "required": true, "type": "string" } ], "post": { "description": "Sets the resource console resolution.", "operationId": "post_resource_console_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ConsoleResolution" } } ], "responses": { "200": { "description": "Resource console resolution has been set.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Set server console resolution", "tags": [ "Power Manager" ] } }, "/power/{resource_uuid}/reboot": { "parameters": [ { "in": "path", "name": "resource_uuid", "required": true, "type": "string" } ], "post": { "description": "Reboots the resource hardware.", "operationId": "post_resource_reboot_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/PowerReboot" } } ], "responses": { "200": { "description": "Resource hardware has been rebooted.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Reboot server", "tags": [ "Power Manager" ] } }, "/promotions/auction": { "get": { "description": "Returns a list of discount campaigns.", "operationId": "get_auction_discount_campaign_list_view", "parameters": [ { "description": "Number of items per page.", "in": "query", "name": "limit", "type": "integer" }, { "description": "Page number for pagination.", "in": "query", "name": "page", "type": "integer" } ], "responses": { "200": { "description": "List of discount campaigns.", "schema": { "$ref": "#/definitions/AuctionDiscountCampaignListResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "List discount campaigns", "tags": [ "Discount Campaign" ] } }, "/promotions/auction/finished": { "get": { "description": "Returns a list of finished discount campaigns.", "operationId": "get_auction_discount_campaign_finished_list_view", "parameters": [ { "description": "Number of items per page.", "in": "query", "name": "limit", "type": "integer" }, { "description": "Page number for pagination.", "in": "query", "name": "page", "type": "integer" } ], "responses": { "200": { "description": "List of finished discount campaigns.", "schema": { "$ref": "#/definitions/AuctionDiscountCampaignListResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "List finished discount campaigns", "tags": [ "Discount Campaign" ] } }, "/promotions/auction/{uuid}": { "get": { "description": "Returns the discount campaign.", "operationId": "get_auction_discount_campaign_view", "responses": { "200": { "description": "Discount campaign has been returned.", "schema": { "$ref": "#/definitions/AuctionDiscountCampaignResultModel" } }, "303": { "description": "Task result has been returned.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Get discount campaign", "tags": [ "Discount Campaign" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/promotions/special_offer": { "get": { "description": "Returns a list of special offers.", "operationId": "get_special_offer_discount_campaign_list_view", "parameters": [ { "default": "name", "description": "Field to sort results by.", "enum": [ "name", "discount", "created", "updated" ], "in": "query", "name": "sort", "type": "string" }, { "description": "Universally unique identifier (UUID) of the service.", "in": "query", "name": "service_uuid", "type": "string" }, { "description": "Number of items per page.", "in": "query", "name": "limit", "type": "integer" }, { "description": "Page number for pagination.", "in": "query", "name": "page", "type": "integer" } ], "responses": { "200": { "description": "List of special offers.", "schema": { "$ref": "#/definitions/SpecialOfferDiscountCampaignResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "List special offers", "tags": [ "Discount Campaign" ] } }, "/resource": { "get": { "description": "List resources.", "operationId": "get_resource_list_view", "parameters": [ { "description": "If true, filters servers ready to connect to blockstorage by local network.", "in": "query", "name": "blockstorage_local_connect_ready", "type": "boolean" }, { "description": "If true, filters servers ready to connect to blockstorage.", "in": "query", "name": "blockstorage_connect_ready", "type": "boolean" }, { "description": "Resource tag identifier.", "in": "query", "name": "resource_tag_id", "type": "integer" }, { "description": "Limit of results per pagination page.", "in": "query", "name": "limit", "type": "integer" }, { "description": "Pagination page number.", "in": "query", "name": "page", "type": "integer" } ], "responses": { "200": { "description": "List of resources.", "schema": { "$ref": "#/definitions/ResourceResultListModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "List resources", "tags": [ "Resources" ] } }, "/resource/billing/info": { "get": { "description": "Get client billing information.", "operationId": "get_resource_client_billing_info_view", "responses": { "200": { "description": "Client billing information has been returned.", "schema": { "$ref": "#/definitions/ClientBillingInfoResultModel" } } }, "summary": "Get client billing information", "tags": [ "Resources" ] } }, "/resource/billing/{uuid}": { "delete": { "description": "Manage resource billing operations.", "operationId": "delete_resource_billing_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceCancelModel" } } ], "responses": { "200": { "description": "Resource has been cancelled.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Cancel resource", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "patch": { "operationId": "patch_resource_billing_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceRestoreModel" } } ], "responses": { "200": { "description": "Resource has been restored.", "schema": { "$ref": "#/definitions/ResourceResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Restore resource", "tags": [ "Resources" ] } }, "/resource/colocation/billing": { "post": { "description": "Manage colocation resource billing.", "operationId": "post_resource_billing_colocation_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceStartColocationModel" } } ], "responses": { "200": { "description": "Colocation resource has been created.", "schema": { "$ref": "#/definitions/ResourceResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Create colocation resource", "tags": [ "Resources" ] } }, "/resource/custom/billing": { "post": { "description": "Manage server custom resource billing.", "operationId": "post_resource_billing_server_custom_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceStartServerCustomModel" } } ], "responses": { "200": { "description": "Server custom resource has been created.", "schema": { "$ref": "#/definitions/ResourceListResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Create server custom resource", "tags": [ "Resources" ] } }, "/resource/firewall/billing": { "post": { "description": "Manage firewall resource billing.", "operationId": "post_resource_billing_firewall_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceStartFirewallModel" } } ], "responses": { "200": { "description": "Firewall resource has been created.", "schema": { "$ref": "#/definitions/ResourceListResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Create firewall resource", "tags": [ "Resources" ] } }, "/resource/layout": { "get": { "description": "List resource by rack layout.", "operationId": "get_resource_layout_view", "responses": { "200": { "description": "List of client racks with resources.", "schema": { "$ref": "#/definitions/ResourceLayoutListResultModel" } } }, "summary": "List resource by rack layout", "tags": [ "Resources" ] } }, "/resource/network/billing": { "post": { "description": "Manage network resource billing.", "operationId": "post_resource_billing_network_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceStartNetworkModel" } } ], "responses": { "200": { "description": "Network resource has been created.", "schema": { "$ref": "#/definitions/ResourceListResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Create network resource", "tags": [ "Resources" ] } }, "/resource/order/{year}": { "get": { "description": "List orders by year.", "operationId": "get_resource_orders_view", "responses": { "200": { "description": "List of resource orders.", "schema": { "$ref": "#/definitions/ResourceOrdersStatResultListModel" } } }, "summary": "List orders by year", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "year", "required": true, "type": "integer" } ] }, "/resource/port/billing": { "post": { "description": "Manage port resource billing.", "operationId": "post_resource_billing_port_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceStartPortModel" } } ], "responses": { "200": { "description": "Port resource has been created.", "schema": { "$ref": "#/definitions/ResourceResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Create port resource", "tags": [ "Resources" ] } }, "/resource/server/billing": { "post": { "description": "Manage server resource billing.", "operationId": "post_resource_billing_server_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceStartServerModel" } } ], "responses": { "200": { "description": "Server resource has been created.", "schema": { "$ref": "#/definitions/ResourceListResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Create server resource", "tags": [ "Resources" ] } }, "/resource/serverchip/billing": { "post": { "description": "Manage serverchip resource billing.", "operationId": "post_resource_billing_serverchip_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceStartServerchipModel" } } ], "responses": { "200": { "description": "Serverchip resource has been created.", "schema": { "$ref": "#/definitions/ResourceListResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Create serverchip resource", "tags": [ "Resources" ] } }, "/resource/tag": { "get": { "description": "List user tags", "operationId": "get_resource_tag_list_view", "parameters": [ { "description": "Limit of results per pagination page.", "in": "query", "name": "limit", "type": "integer" }, { "description": "Pagination page number.", "in": "query", "name": "page", "type": "integer" } ], "responses": { "200": { "description": "List of user tags.", "schema": { "$ref": "#/definitions/ResourceTagResultListModel" } } }, "summary": "List user tags", "tags": [ "Resources" ] }, "post": { "operationId": "post_resource_tag_list_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceTagCreateUpdateModel" } } ], "responses": { "200": { "description": "User tag has been created.", "schema": { "$ref": "#/definitions/ResourceTagResultModel" } } }, "summary": "Create user tag", "tags": [ "Resources" ] } }, "/resource/tag/{uuid}": { "delete": { "operationId": "delete_resource_tag_view", "responses": { "200": { "description": "User tag has been deleted.", "schema": { "$ref": "#/definitions/ResourceTagResultModel" } } }, "summary": "Delete user tag", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "description": "Manage individual user tags.", "operationId": "put_resource_tag_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceTagCreateUpdateModel" } } ], "responses": { "200": { "description": "User tag has been updated.", "schema": { "$ref": "#/definitions/ResourceTagResultModel" } } }, "summary": "Update user tag", "tags": [ "Resources" ] } }, "/resource/{resource_uuid}/project": { "parameters": [ { "in": "path", "name": "resource_uuid", "required": true, "type": "string" } ], "put": { "description": "Update resource project assignment.", "operationId": "put_resource_project_update_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceUpdateProjectModel" } } ], "responses": { "200": { "description": "Resource project has been updated.", "schema": { "$ref": "#/definitions/ResourceResultModel" } } }, "summary": "Update resource project", "tags": [ "Resources" ] } }, "/resource/{resource_uuid}/upgrade/custom": { "parameters": [ { "in": "path", "name": "resource_uuid", "required": true, "type": "string" } ], "post": { "description": "Manage custom resource upgrades.", "operationId": "post_resource_upgrade_custom_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceCustomUpgradeAddModel" } } ], "responses": { "200": { "description": "Resource custom upgrade has been created.", "schema": { "$ref": "#/definitions/ResourceUpgradeResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Create resource custom upgrade", "tags": [ "Resources" ] } }, "/resource/{resource_uuid}/upgrade/prebuilt": { "parameters": [ { "in": "path", "name": "resource_uuid", "required": true, "type": "string" } ], "post": { "description": "Manage prebuilt resource upgrades.", "operationId": "post_resource_upgrade_prebuilt_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourcePrebuiltUpgradeRequestModel" } } ], "responses": { "200": { "description": "Resource prebuilt upgrade has been created.", "schema": { "$ref": "#/definitions/ResourceResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Create resource prebuilt upgrade", "tags": [ "Resources" ] } }, "/resource/{uuid}": { "get": { "description": "Get resource.", "operationId": "get_resource_view", "responses": { "200": { "description": "Resource object has been returned.", "schema": { "$ref": "#/definitions/ResourceResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Get resource", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "description": "Update resource.", "operationId": "put_resource_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceUpdateModel" } } ], "responses": { "200": { "description": "Resource has been updated.", "schema": { "$ref": "#/definitions/ResourceResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Update resource", "tags": [ "Resources" ] } }, "/resource/{uuid}/aux_network_info": { "get": { "description": "Get resource auxiliary network info.", "operationId": "get_resource_aux_network_info_view", "responses": { "200": { "description": "Resource object with auxiliary network info has been returned.", "schema": { "$ref": "#/definitions/ResourceAuxNetworkInfoResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Get resource auxiliary network info", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/resource/{uuid}/billing": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "post": { "description": "Manage additional resource billing.", "operationId": "post_resource_billing_additional_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceStartAdditionalModel" } } ], "responses": { "200": { "description": "Additional resource has been created.", "schema": { "$ref": "#/definitions/ResourceResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Create additional resource", "tags": [ "Resources" ] }, "put": { "operationId": "put_resource_billing_additional_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceStartAdditionalListModel" } } ], "responses": { "200": { "description": "Additional resource list has been created.", "schema": { "$ref": "#/definitions/ResourceListResultModel" } }, "202": { "description": "Task has been queued for processing.", "schema": { "$ref": "#/definitions/ResponseBaseModel" } } }, "summary": "Create additional resource list", "tags": [ "Resources" ] } }, "/resource/{uuid}/compensation": { "get": { "description": "List resource compensation.", "operationId": "get_resource_compensation_view", "responses": { "200": { "description": "List of resource compensation.", "schema": { "$ref": "#/definitions/ResourceOrderCompensationDetailModel" } } }, "summary": "List resource compensation", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/resource/{uuid}/info/colocation": { "get": { "description": "Get colocation resource information.", "operationId": "get_resource_colocation_info_view", "responses": { "200": { "description": "Colocation resource information has been returned.", "schema": { "$ref": "#/definitions/ResourceColocationInfoResultModel" } } }, "summary": "Get colocation resource information", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "description": "Update colocation resource information.", "operationId": "put_resource_colocation_info_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceColocationInfoUpdateModel" } } ], "responses": { "200": { "description": "Colocation resource information has been updated.", "schema": { "$ref": "#/definitions/ResourceColocationInfoResultModel" } } }, "summary": "Update colocation resource information", "tags": [ "Resources" ] } }, "/resource/{uuid}/info/custom": { "get": { "description": "Get custom resource information.", "operationId": "get_resource_custom_info_view", "responses": { "200": { "description": "Custom resource information has been returned.", "schema": { "$ref": "#/definitions/ResourceCustomInfoResultModel" } } }, "summary": "Get custom resource information", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/resource/{uuid}/info/network_equipment": { "get": { "description": "Get network equipment resource information.", "operationId": "get_resource_network_equipment_info_view", "responses": { "200": { "description": "Network equipment resource information has been returned.", "schema": { "$ref": "#/definitions/ResourceNetworkEquipmentInfoResultModel" } } }, "summary": "Get network equipment resource information", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/resource/{uuid}/info/port": { "get": { "description": "Get port resource information.", "operationId": "get_resource_port_info_view", "responses": { "200": { "description": "Port resource information has been returned.", "schema": { "$ref": "#/definitions/ResourceServerInfoResultModel" } } }, "summary": "Get port resource information", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/resource/{uuid}/info/server": { "get": { "description": "Get server resource information.", "operationId": "get_resource_server_info_view", "responses": { "200": { "description": "Server resource information has been returned.", "schema": { "$ref": "#/definitions/ResourceServerInfoResultModel" } } }, "summary": "Get server resource information", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/resource/{uuid}/info/serverchip": { "get": { "description": "Get serverchip resource information.", "operationId": "get_resource_serverchip_info_view", "responses": { "200": { "description": "Serverchip resource information has been returned.", "schema": { "$ref": "#/definitions/ResourceServerInfoResultModel" } } }, "summary": "Get serverchip resource information", "tags": [ "Resources" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/resource/{uuid}/tag": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "description": "Manage resource tags.", "operationId": "put_resource_tag_manage_view", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ResourceTagManageModel" } } ], "responses": { "200": { "description": "Resource tags have been updated.", "schema": { "$ref": "#/definitions/ResourceTagResultListModel" } } }, "summary": "Update resource tags", "tags": [ "Resources" ] } }, "/result/{uuid}": { "get": { "operationId": "get_task_view", "responses": { "200": { "description": "Task result has been returned.", "schema": { "$ref": "#/definitions/ResponseBaseAsyncModel" } }, "303": { "description": "Task result has been returned.", "schema": { "$ref": "#/definitions/ResponseBaseAsyncModel" } }, "404": { "description": "Task has not been found.", "schema": { "$ref": "#/definitions/ResponseBaseAsyncModel" } } }, "summary": "Get task", "tags": [ "Tasks" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/service": { "get": { "description": "Returns a list of services with optional filtering.", "operationId": "listServices", "parameters": [ { "description": "Indicates whether the service is hidden from view.", "in": "query", "name": "is_hidden", "type": "boolean" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" }, { "description": "If true, only editable services will be returned.", "in": "query", "name": "is_editable", "type": "boolean" }, { "description": "If true, only primary services will be returned.", "in": "query", "name": "is_primary", "type": "boolean" }, { "description": "Billing state of the service.", "in": "query", "name": "state", "type": "string" }, { "description": "Service model type.", "enum": [ "default", "colocation", "server", "serverchip", "custom", "rack", "network", "equipment", "firewall", "port", "network_equipment", "service", "software" ], "in": "query", "name": "model", "type": "string" } ], "responses": { "200": { "description": "List of services.", "schema": { "$ref": "#/definitions/ResponseServiceListResult" } } }, "summary": "List services", "tags": [ "Services" ] } }, "/service/colocation": { "get": { "description": "Returns a list of colocation services.", "operationId": "listColocationServices", "parameters": [ { "description": "Indicates whether the service is hidden from view.", "in": "query", "name": "is_hidden", "type": "boolean" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" } ], "responses": { "200": { "description": "List of colocation services.", "schema": { "$ref": "#/definitions/ResponseColocationListResult" } } }, "summary": "List colocation services", "tags": [ "Services" ] } }, "/service/colocation/{uuid}": { "get": { "description": "Returns the colocation service details by UUID.", "operationId": "getColocationService", "responses": { "200": { "description": "Colocation service has been returned.", "schema": { "$ref": "#/definitions/ResponseColocationResult" } } }, "summary": "Get colocation service", "tags": [ "Services" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/service/colocation/{uuid}/billing": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "post": { "description": "Calculates the billing for a colocation service.", "operationId": "calculateColocationBilling", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ServiceBillingCheckModel" } } ], "responses": { "200": { "description": "Service billing has been calculated.", "schema": { "$ref": "#/definitions/ResponseServiceBillingResult" } } }, "summary": "Calculate service billing", "tags": [ "Services" ] } }, "/service/custom": { "get": { "description": "Returns a list of custom server services.", "operationId": "listCustomServers", "parameters": [ { "description": "Indicates whether the service is hidden from view.", "in": "query", "name": "is_hidden", "type": "boolean" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" } ], "responses": { "200": { "description": "List of custom server services.", "schema": { "$ref": "#/definitions/ResponseServerCustomListResult" } } }, "summary": "List custom servers", "tags": [ "Services" ] } }, "/service/custom/{uuid}": { "get": { "description": "Returns the custom server service details by UUID.", "operationId": "getCustomServerDetails", "responses": { "200": { "description": "Custom server service has been returned.", "schema": { "$ref": "#/definitions/ResponseServerCustomResult" } } }, "summary": "Get custom server details", "tags": [ "Services" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/service/custom/{uuid}/billing": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "post": { "description": "Calculates the billing for a custom server service.", "operationId": "calculateCustomBilling", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ServiceCustomBillingCheckModel" } } ], "responses": { "200": { "description": "Service billing has been calculated.", "schema": { "$ref": "#/definitions/ResponseServiceBillingResult" } } }, "summary": "Calculate service billing", "tags": [ "Services" ] } }, "/service/custom/{uuid}/billing/upgrade": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "description": "Calculates the resource upgrade billing for a custom server service.", "operationId": "calculateCustomUpgradeBilling", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ServiceCustomUpgradeBillingCheckModel" } } ], "responses": { "200": { "description": "Service billing has been calculated.", "schema": { "$ref": "#/definitions/ResponseServiceCustomUpgradeBillingResult" } } }, "summary": "Calculate service resource upgrade billing", "tags": [ "Services" ] } }, "/service/firewall": { "get": { "description": "Returns a list of firewall services.", "operationId": "listFirewallServices", "parameters": [ { "description": "Indicates whether the service is hidden from view.", "in": "query", "name": "is_hidden", "type": "boolean" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" } ], "responses": { "200": { "description": "List of firewall services.", "schema": { "$ref": "#/definitions/ResponseFirewallListResult" } } }, "summary": "List firewall services", "tags": [ "Services" ] } }, "/service/firewall/{uuid}": { "get": { "description": "Returns the firewall service details by UUID.", "operationId": "getFirewallService", "responses": { "200": { "description": "Firewall service has been returned.", "schema": { "$ref": "#/definitions/ResponseFirewallResult" } } }, "summary": "Get firewall service", "tags": [ "Services" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/service/lite": {}, "/service/lite/colocation": {}, "/service/lite/custom": {}, "/service/lite/firewall": {}, "/service/lite/network": {}, "/service/lite/port": {}, "/service/lite/server": {}, "/service/lite/serverchip": {}, "/service/network": { "get": { "description": "Returns a list of network services.", "operationId": "listNetworkServices", "parameters": [ { "description": "Indicates whether the service is hidden from view.", "in": "query", "name": "is_hidden", "type": "boolean" }, { "description": "Billing state of the service.", "in": "query", "name": "state", "type": "string" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" } ], "responses": { "200": { "description": "List of network services.", "schema": { "$ref": "#/definitions/ResponseNetworkListResult" } } }, "summary": "List network services", "tags": [ "Services" ] } }, "/service/network/{uuid}": { "get": { "description": "Returns the network service details by UUID.", "operationId": "getNetworkService", "responses": { "200": { "description": "Network service has been returned.", "schema": { "$ref": "#/definitions/ResponseNetworkResult" } } }, "summary": "Get network service", "tags": [ "Services" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/service/network/{uuid}/billing": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "post": { "description": "Calculates the billing for a network service.", "operationId": "calculateNetworkBilling", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ServiceBillingCheckModel" } } ], "responses": { "200": { "description": "Service billing has been calculated.", "schema": { "$ref": "#/definitions/ResponseServiceBillingResult" } } }, "summary": "Calculate service billing", "tags": [ "Services" ] } }, "/service/network_equipment": { "get": { "description": "Returns a list of network equipment services.", "operationId": "listNetworkEquipmentServices", "parameters": [ { "description": "Indicates whether the service is hidden from view.", "in": "query", "name": "is_hidden", "type": "boolean" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" } ], "responses": { "200": { "description": "List of network equipment services.", "schema": { "$ref": "#/definitions/ResponseNetworkEquipmentListResult" } } }, "summary": "List network equipment services", "tags": [ "Services" ] } }, "/service/network_equipment/{uuid}": { "get": { "description": "Returns the network equipment service details by UUID.", "operationId": "getNetworkEquipmentService", "responses": { "200": { "description": "Network equipment service has been returned.", "schema": { "$ref": "#/definitions/ResponseNetworkEquipmentResult" } } }, "summary": "Get network equipment service", "tags": [ "Services" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/service/port": { "get": { "description": "Returns a list of port services.", "operationId": "listPortServices", "parameters": [ { "description": "Indicates whether the service is hidden from view.", "in": "query", "name": "is_hidden", "type": "boolean" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" } ], "responses": { "200": { "description": "List of port services.", "schema": { "$ref": "#/definitions/ResponsePortListResult" } } }, "summary": "List port services", "tags": [ "Services" ] } }, "/service/port/{uuid}": { "get": { "description": "Returns the port service details by UUID.", "operationId": "getPortService", "responses": { "200": { "description": "Port service has been returned.", "schema": { "$ref": "#/definitions/ResponsePortResult" } } }, "summary": "Get port service", "tags": [ "Services" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/service/port/{uuid}/billing": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "post": { "description": "Calculates the billing for a port service.", "operationId": "calculatePortBilling", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ServiceBillingCheckModel" } } ], "responses": { "200": { "description": "Service billing has been calculated.", "schema": { "$ref": "#/definitions/ResponseServiceBillingResult" } } }, "summary": "Calculate service billing", "tags": [ "Services" ] } }, "/service/server": { "get": { "description": "Returns a list of dedicated server services.", "operationId": "listServers", "parameters": [ { "description": "Indicates whether the service is hidden from view.", "in": "query", "name": "is_hidden", "type": "boolean" }, { "description": "Billing state of the service.", "in": "query", "name": "state", "type": "string" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" } ], "responses": { "200": { "description": "List of dedicated server services.", "schema": { "$ref": "#/definitions/ResponseServerListResult" } } }, "summary": "List servers", "tags": [ "Services" ] } }, "/service/server/{uuid}": { "get": { "description": "Returns the dedicated server service details by UUID.", "operationId": "getServerDetails", "responses": { "200": { "description": "Dedicated server service has been returned.", "schema": { "$ref": "#/definitions/ResponseServerResult" } } }, "summary": "Get server details", "tags": [ "Services" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/service/server/{uuid}/billing": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "post": { "description": "Calculates the billing for a server service.", "operationId": "calculateServerBilling", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ServiceBillingCheckModel" } } ], "responses": { "200": { "description": "Service billing has been calculated.", "schema": { "$ref": "#/definitions/ResponseServiceBillingResult" } } }, "summary": "Calculate service billing", "tags": [ "Services" ] } }, "/service/serverchip": { "get": { "description": "Returns a list of Chipcore server services.", "operationId": "listChipcoreServers", "parameters": [ { "description": "Indicates whether the service is hidden from view.", "in": "query", "name": "is_hidden", "type": "boolean" }, { "default": "created", "description": "Field to sort results by.", "enum": [ "created", "name" ], "in": "query", "name": "sort", "type": "string" }, { "default": "asc", "description": "Order direction for sorting results.", "enum": [ "desc", "asc" ], "in": "query", "name": "order", "type": "string" } ], "responses": { "200": { "description": "List of Chipcore server services.", "schema": { "$ref": "#/definitions/ResponseServerListResult" } } }, "summary": "List Chipcore servers", "tags": [ "Services" ] } }, "/service/serverchip/{uuid}": { "get": { "description": "Returns the Chipcore server service details by UUID.", "operationId": "getChipcoreServerDetails", "responses": { "200": { "description": "Chipcore server service has been returned.", "schema": { "$ref": "#/definitions/ResponseServerResult" } } }, "summary": "Get Chipcore server details", "tags": [ "Services" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/service/serverchip/{uuid}/billing": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "post": { "description": "Calculates the billing for a serverchip service.", "operationId": "calculateServerchipBilling", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ServiceBillingCheckModel" } } ], "responses": { "200": { "description": "Service billing has been calculated.", "schema": { "$ref": "#/definitions/ResponseServiceBillingResult" } } }, "summary": "Calculate service billing", "tags": [ "Services" ] } }, "/service/tag_catalog": { "get": { "description": "Returns a list of tags from the service tag catalog.", "operationId": "listServiceTagCatalog", "responses": { "200": { "description": "List of tags from the service tag catalog.", "schema": { "$ref": "#/definitions/ResponseServiceTagCatalogListResult" } } }, "summary": "Get service tag catalog list", "tags": [ "Services" ] } }, "/service/tag_catalog/{uuid}": { "get": { "description": "Returns a tag from the service tag catalog by UUID.", "operationId": "getServiceCatalogTag", "responses": { "200": { "description": "Service tag has been returned.", "schema": { "$ref": "#/definitions/ResponseServiceTagCatalogResult" } } }, "summary": "Get service catalog tag", "tags": [ "Services" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/service/{uuid}": { "get": { "description": "Returns the service details by UUID.", "operationId": "getServiceDetails", "responses": { "200": { "description": "Service details have been returned.", "schema": { "$ref": "#/definitions/ResponseServiceResult" } } }, "summary": "Get service details", "tags": [ "Services" ] }, "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] }, "/service/{uuid}/billing": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "description": "Calculates the resource billing for a service.", "operationId": "calculateResourceBilling", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ServiceResourceBillingCheckModel" } } ], "responses": { "200": { "description": "Service billing has been calculated.", "schema": { "$ref": "#/definitions/ResponseServiceBillingResult" } } }, "summary": "Calculate resource billing for the service", "tags": [ "Services" ] } }, "/service/{uuid}/billing/additional": { "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ], "put": { "description": "Calculates the additional resource billing for a service.", "operationId": "calculateAdditionalBilling", "parameters": [ { "in": "body", "name": "payload", "required": true, "schema": { "$ref": "#/definitions/ServiceResourceAdditionalBillingCheckModel" } } ], "responses": { "200": { "description": "Additional service billing has been calculated.", "schema": { "$ref": "#/definitions/ResponseServiceBillingResult" } } }, "summary": "Calculate additional resource billing for the service", "tags": [ "Services" ] } } }, "produces": [ "application/json" ], "responses": { "BadRequest": {}, "Exception": { "description": "Default handler for not seido exceptions" }, "MaskError": { "description": "When any error occurs on mask" }, "MethodNotAllowed": {}, "NetconfAPIError": { "description": "Handle all netconf api errors" }, "ParseError": { "description": "When a mask can't be parsed" }, "SeidoException": { "description": "Handle all seido exceptions" }, "SeidoSchemaValidationError": {} }, "security": [ { "iam_token_account_scoped": [] }, { "iam_token_project_scoped": [] } ], "securityDefinitions": { "iam_token_account_scoped": { "description": "IAM token for account", "in": "header", "name": "X-AUTH-TOKEN", "type": "apiKey" }, "iam_token_project_scoped": { "description": "IAM token for project", "in": "header", "name": "X-AUTH-TOKEN", "type": "apiKey" } }, "swagger": "2.0", "tags": [ { "description": "Retrieving API health information, maintenance status, and active tasks.", "name": "Dashboard" }, { "description": "Listing and retrieving information about available locations.", "name": "Locations" }, { "description": "Managing dedicated server services: listing and retrieving service details, calculating billing for servers, colocation, network, port, firewall, and custom services.", "name": "Services" }, { "description": "Listing and retrieving price plan details.", "name": "Price Plans" }, { "description": "Managing dedicated server resources: creating and ordering servers, billing operations, tagging for organization, resource information retrieval, upgrades, and more.", "name": "Resources" }, { "description": "Managing server power state: getting and setting power state, rebooting servers, and managing console access.", "name": "Power Manager" }, { "description": "Managing server boot configuration: listing templates, installing and reinstalling OS, managing partitions, and retrieving OS passwords.", "name": "Boot Manager" }, { "description": "Listing and filtering events.", "name": "Events" }, { "description": "Retrieving task results by identifier.", "name": "Tasks" }, { "description": "Managing networks, subnets, and IP addresses: creating and configuring networks, allocating and releasing IP addresses, managing local subnets and local IP addresses, configuring network limits, managing ports and basic firewall rules, and more.", "name": "Network Management API" }, { "description": "Retrieving speed and traffic consumption data for resources, networks, and locations.", "name": "Consumption" }, { "description": "Managing names, user names, and tags through the name service.", "name": "Miscellaneous" }, { "description": "Listing and retrieving discount campaigns and special offers.", "name": "Discount Campaign" }, { "description": "Retrieving Block Storage access flags.", "name": "Block Storage Manager" } ] }