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