DCImanager Administrator

DCImanager API

ISPSystem
{ "openapi": "3.0.0", "info": { "title": "DCImanager 6 API", "description": "DCImanager 6 API", "version": "3.0.0" }, "servers": [ { "url": "https://127.0.0.1/api/dci/v3" } ], "tags": [ { "name": "common", "description": "General" }, { "name": "ip", "description": "IP addresses" }, { "name": "ipmgr", "description": "IPmgr6" }, { "name": "ipmi", "description": "IPMI" }, { "name": "license", "description": "Licensing" }, { "name": "location", "description": "Locations" }, { "name": "operation", "description": "Operations" }, { "name": "os_template", "description": "OS templates" }, { "name": "pdu", "description": "PDU" }, { "name": "pdu_connection", "description": "PDU connections" }, { "name": "rack", "description": "Racks" }, { "name": "server", "description": "Servers" }, { "name": "switch", "description": "Switches" }, { "name": "power", "description": "Server power management" }, { "name": "switch_connection", "description": "Switch connections" }, { "name": "user", "description": "Users" }, { "name": "platform", "description": "Platforms" }, { "name": "cpu_socket", "description": "CPU socket" }, { "name": "update", "description": "Panel updates" }, { "name": "chassis", "description": "Blade Server Chassis" }, { "name": "vlan", "description": "VLAN" } ], "components": { "securitySchemes": { "cookieAuth": { "type": "apiKey", "in": "cookie", "name": "ses6" }, "headerHost": { "type": "apiKey", "in": "header", "name": "host" } }, "schemas": { "PlatformCreatePostParams": { "additionalProperties": false, "required": [ "name", "type", "server_size", "cpu_socket", "cpu_socket_count", "ram_slot_count", "max_ram", "hdd_slot_count", "pci_slot_count" ], "type": "object", "properties": { "name": { "description": "Platform name", "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^([\\w]+)([\\w\\- ]+)$", "example": "Platform 1" }, "type": { "description": "Server type", "type": "string", "enum": [ "server", "blade" ] }, "server_size": { "description": "Server size", "type": "integer", "minimum": 1, "maximum": 2 }, "cpu_socket": { "description": "CPU socket ID", "type": "integer" }, "cpu_socket_count": { "description": "Number of sockets for cpu", "enum": [ 1, 2, 4, 8 ], "type": "integer" }, "ram_slot_count": { "description": "Number of slots for RAM", "type": "integer", "minimum": 1, "maximum": 64 }, "max_ram": { "description": "Maximum RAM size", "type": "integer", "minimum": 1, "maximum": 2147483647 }, "hdd_slot_count": { "description": "Number of slots for hdd_slot_count", "type": "integer", "minimum": 1, "maximum": 90 }, "pci_slot_count": { "description": "Number of slots for PCI-devices", "type": "integer", "minimum": 1, "maximum": 30 } } }, "PlatformEditPostParams": { "additionalProperties": false, "type": "object", "properties": { "name": { "description": "Platform name", "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^([\\w]+)([\\w\\- ]+)$" }, "cpu_socket": { "description": "CPU socket ID", "type": "integer" }, "cpu_socket_count": { "description": "Number of sockets for cpu", "enum": [ 1, 2, 4, 8 ], "type": "integer" }, "ram_slot_count": { "description": "Number of slots for RAM", "type": "integer", "minimum": 1, "maximum": 64 }, "max_ram": { "description": "Maximum RAM size", "type": "integer", "minimum": 1, "maximum": 2147483647 }, "hdd_slot_count": { "description": "Number of slots for hdd_slot_count", "type": "integer", "minimum": 1, "maximum": 90 }, "pci_slot_count": { "description": "Number of slots for PCI-devices", "type": "integer", "minimum": 1, "maximum": 30 } } }, "PlatformGetResponse": { "properties": { "id": { "type": "integer", "description": "Platform identifier" }, "name": { "description": "Platform name", "type": "string" }, "type": { "description": "Server type", "type": "string" }, "server_size": { "description": "Server size", "type": "number" }, "cpu_socket": { "description": "CPU socket ID", "type": "integer" }, "cpu_socket_count": { "description": "Number of sockets for cpu", "type": "integer" }, "ram_slot_count": { "description": "Number of slots for RAM", "type": "integer" }, "max_ram": { "description": "Maximum RAM size", "type": "integer" }, "hdd_slot_count": { "description": "Number of slots for hdd_slot_count", "type": "integer" }, "pci_slot_count": { "description": "Number of slots for PCI-devices", "type": "integer" } }, "type": "object" }, "PlatformListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/PlatformGetResponse" }, "type": "array" } }, "type": "object" }, "OsTemplateGetResponse": { "properties": { "datetime": { "type": "string" }, "filename": { "type": "string" }, "id": { "type": "integer" }, "locations": { "items": { "properties": { "datetime": { "type": "string" }, "location": { "type": "integer" }, "status": { "enum": [ "ok", "fail", "installing", "deleting", "need_update" ], "type": "string" }, "status_info": { "type": "object" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "status": { "enum": [ "none", "installed" ], "type": "string" }, "status_info": { "type": "object" }, "tags": { "items": { "type": "string" }, "type": "array" }, "type": { "enum": [ "ostemplate", "diag", "rescue", "serversearch", "isotemplate" ], "type": "string" }, "version": { "type": "string" }, "macro": { "description": "OS template macros redefinition", "type": "object" } }, "type": "object" }, "OsTemplateListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/OsTemplateGetResponse" }, "type": "array" } }, "type": "object" }, "OsTemplateSetupPostParams": { "properties": { "os_templates": { "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "OsTemplateEditParams": { "additionalProperties": false, "type": "object", "properties": { "macro": { "description": "OS template macros redefinition", "example": "{\"($NAMESERVER)\": \"1.1.1.1\"}", "type": "object" } } }, "ServerOperationFinishPostParams": { "type": "object", "properties": { "hardware_info": { "description": "Server configuration information", "type": "object" } } }, "ServerOperationFailPostParams": { "type": "object", "properties": { "reason": { "description": "Server configuration information", "type": "string" } } }, "ServerOperationOsPostParams": { "additionalProperties": false, "properties": { "hdd_raid": { "enum": [ "no_raid", "raid_0", "raid_1", "raid_5", "raid_10" ], "type": "string" }, "os_template_id": { "description": "Template identifier", "type": "integer" }, "password": { "example": "password", "pattern": "^[^ ]", "type": "string" }, "ssh_pub_keys": { "type": "array", "description": "Public ssh keys", "items": { "type": "string", "format": "sshkey" } } }, "required": [ "os_template_id", "password" ], "type": "object" }, "ServerOperationDiagPostParams": { "type": "object", "additionalProperties": false, "required": [ "os_template_id", "clear_hdd" ], "properties": { "setup_ipmi": { "type": "boolean", "description": "Option allows to configure IPMI" }, "os_template_id": { "type": "integer", "description": "Diagnostics template identifier" }, "clear_hdd": { "type": "string", "description": "Disk cleanup type: * none - without cleanup * simple - quick cleanup * full - full cleanup\n", "enum": [ "none", "simple", "full" ] } } }, "ServerOperationRescuePostParams": { "type": "object", "additionalProperties": false, "required": [ "os_template_id", "password" ], "properties": { "os_template_id": { "type": "integer", "description": "Rescue template identifier" }, "password": { "type": "string" } } }, "ServerOperationClearHddPostParams": { "type": "object", "additionalProperties": false, "required": [ "clear_hdd" ], "properties": { "clear_hdd": { "type": "string", "description": "Disk cleanup type: * none - without cleanup * simple - quick cleanup * full - full cleanup\n", "enum": [ "none", "simple", "full" ] } } }, "SetupPostParams": { "properties": { "ip": { "description": "SSH IP address", "example": "127.0.0.1", "format": "ipv4", "type": "string" }, "ssh_port": { "description": "SSH access port", "example": 22, "maximum": 65535, "minimum": 1, "type": "integer" }, "user_email": { "description": "User email", "example": "admin@example.com", "format": "email", "type": "string" }, "user_id": { "description": "User identifier", "example": 2, "type": "integer" }, "username": { "description": "SSH access username", "example": "root", "minLength": 1, "type": "string" } }, "required": [ "ip", "ssh_port", "username", "user_id", "user_email" ], "type": "object" }, "BoxSetupPostParams": { "properties": { "is_box": { "description": "Checkbox that indicates setting up of the box-instance", "example": true, "type": "boolean" }, "user_id": { "description": "User identifier", "example": 2, "type": "integer" }, "user_email": { "description": "User email", "example": "admin@example.com", "format": "email", "type": "string" } }, "required": [ "is_box", "user_id", "user_email" ], "type": "object" }, "InfoGetResponse": { "properties": { "location": { "description": "Information about the main location", "properties": { "id": { "description": " Location ID (admin only)", "type": "integer" }, "ssh_address": { "description": "Location SSH-address (admin only)", "type": "string" }, "ssh_port": { "description": "Location SSH-port (admin only)", "type": "integer" }, "ssh_user": { "description": "Location SSH-user (admin only)", "type": "string" }, "status": { "description": "Location status", "enum": [ "created", "check_failed", "need_setup", "setup", "ok", "setup_failed" ], "type": "string" } }, "type": "object" } }, "type": "object" }, "UserSettingsParams": { "type": "object", "additionalProperties": true, "properties": {} }, "EmptySchema": { "additionalProperties": false, "properties": {}, "type": "object" }, "ErrorSchema": { "properties": { "error": { "properties": { "code": { "type": "integer" }, "msg": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } }, "type": "object" }, "Id": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "SuccessSchema": { "$ref": "#/components/schemas/Id" }, "SuccessTaskArraySchema": { "properties": { "task": { "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "SuccessTaskOnlySchema": { "properties": { "task": { "type": "integer" } }, "type": "object" }, "SuccessTaskSchema": { "properties": { "id": { "type": "integer" }, "task": { "type": "integer" } }, "type": "object" }, "SuccessTasksIdSchema": { "properties": { "id": { "type": "integer" }, "task": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "LocationSubquery": { "properties": { "geolocation": { "description": "Location address", "example": "1st Street, 25", "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "userspace": { "description": "Userspace ID in IPmgr6 for pools and networks of this location", "type": "integer" } }, "type": "object" }, "RackSubquery": { "properties": { "id": { "description": "Rack identifier", "type": "integer" }, "name": { "description": "Rack name", "type": "string" }, "size": { "description": "Rack size", "type": "integer" } }, "type": "object" }, "ChassisSubquery": { "properties": { "id": { "description": "Chassis identifier", "type": "integer" }, "name": { "description": "Chassis name", "type": "string" }, "size": { "description": "Chassis size", "type": "integer" }, "server_slot_count": { "description": "Number of slots in chassis for blade servers", "type": "integer" } }, "type": "object" }, "eAdminStatus": { "type": "string", "description": "Status of the switch port managed by administrator * `up` - port enabled * `down` - port disabled * `testing` - port status is test * `unknown` - unknown port status\n", "enum": [ "up", "down", "testing", "unknown" ] }, "eOperStatus": { "type": "string", "description": "Link status of switch port * `up` - Link ON * `down` - Link OFF * `testing` - port status is test * `unknown` - unknown link status\n", "enum": [ "up", "down", "testing", "unknown" ] }, "SupportedDevicesListResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "properties": { "name": { "description": "Device type", "type": "string", "example": "cisco_snmp" }, "protocol": { "description": "Protocols for device management", "type": "array", "items": { "type": "string" } } } } } } }, "DeviceSnmpParams": { "description": "SNMP connection parameters", "type": "object", "properties": { "hostname": { "description": "Equipment address", "type": "string", "format": "ipv4", "example": "127.0.0.1" }, "security_username": { "description": "Username for SNMP access", "type": "string", "minLength": 1, "example": "root", "pattern": "^[^ ]" }, "version": { "description": "SNMP version", "type": "string", "enum": [ "snmp_v1", "snmp_v2c", "snmp_v3" ] }, "community": { "description": "Community", "type": "string" }, "security_level": { "description": "Authentication level", "type": "string", "enum": [ "no_auth_or_privacy", "auth_without_privacy", "auth_with_privacy" ] }, "auth_protocol": { "description": "Authentication protocol", "type": "string", "enum": [ "MD5", "SHA" ] }, "auth_password": { "description": "Authentication protocol pass phrase", "type": "string" }, "privacy_protocol": { "description": "Privacy protocol", "type": "string", "enum": [ "DES", "AES" ] }, "privacy_password": { "description": "Privacy protocol pass phrase", "type": "string" } } }, "DeviceSshParams": { "description": "SSH connection parameters", "type": "object", "properties": { "password": { "description": "Password", "type": "string" }, "port": { "description": "SSH access ports", "example": 22, "maximum": 65535, "minimum": 1, "type": "integer" }, "user": { "description": "SSH access username", "example": "root", "minLength": 1, "pattern": "^[^ ]", "type": "string" } } }, "DeviceNetconfParams": { "description": "NETCONF connection parameters", "type": "object", "properties": { "username": { "description": "Username", "type": "string" }, "password": { "description": "Password", "type": "string" }, "port": { "description": "NETCONF access ports", "example": 830, "maximum": 65535, "minimum": 1, "type": "integer" }, "device_params": { "description": "NETCONF device parameters", "type": "object", "properties": { "name": { "description": "OS name", "type": "string", "enum": [ "junos" ], "default": "junos" } } } } }, "SwitchCreatePostParams": { "additionalProperties": false, "properties": { "device": { "description": "Device", "enum": [ "cisco_snmp", "snmp_common", "juniper_without_els" ], "type": "string" }, "ip": { "description": "Switch IP address", "example": "127.0.0.1", "format": "ipv4", "type": "string" }, "name": { "description": "Switch name", "example": "my key name", "pattern": "^[^ ]", "minLength": 1, "maxLength": 49, "type": "string" }, "note": { "description": "Comment", "maxLength": 1500, "type": "string" }, "rack": { "description": "Rack", "example": "1", "type": "integer" }, "unit": { "description": "Starting unit where the switch is located", "maximum": 99, "minimum": 1, "example": "1", "type": "integer" }, "size": { "description": "Switch size in units", "maximum": 99, "minimum": 1, "example": "1", "type": "integer" }, "snmp_params": { "$ref": "#/components/schemas/DeviceSnmpParams" }, "ssh_params": { "$ref": "#/components/schemas/DeviceSshParams" }, "netconf_params": { "$ref": "#/components/schemas/DeviceNetconfParams" } }, "required": [ "name", "ip", "device", "rack", "unit", "size" ], "type": "object" }, "SwitchEditPostParams": { "additionalProperties": false, "properties": { "ip": { "description": "Switch IP address", "example": "127.0.0.1", "format": "ipv4", "type": "string" }, "name": { "description": "Switch name", "example": "my key name", "pattern": "^[^ ]", "minLength": 1, "maxLength": 49, "type": "string" }, "note": { "description": "Comment", "maxLength": 1500, "type": "string" }, "unit": { "description": "Starting unit where switch is located", "maximum": 99, "minimum": 1, "example": "1", "type": "integer" }, "size": { "description": "Switch size in units", "maximum": 99, "minimum": 1, "example": "1", "type": "integer" }, "snmp_params": { "$ref": "#/components/schemas/DeviceSnmpParams" }, "ssh_params": { "$ref": "#/components/schemas/DeviceSshParams" }, "netconf_params": { "$ref": "#/components/schemas/DeviceNetconfParams" } }, "type": "object" }, "SwitchInfoEditPostParams": { "additionalProperties": false, "properties": { "switch_port_info": { "type": "array", "items": { "type": "object", "properties": { "ip": { "description": "Switch IP address", "example": "127.0.0.1", "format": "ipv4", "type": "string" }, "name": { "description": "Switch name", "example": "my key name", "pattern": "^[^ ]", "type": "string" }, "note": { "description": "Comment", "type": "string" }, "unit": { "description": "Starting unit where the switch is located", "maximum": 99, "minimum": 1, "example": "1", "type": "integer" }, "size": { "description": "Switch size in units", "maximum": 99, "minimum": 1, "example": "1", "type": "integer" }, "snmp_params": { "$ref": "#/components/schemas/DeviceSnmpParams" }, "ssh_params": { "$ref": "#/components/schemas/DeviceSshParams" }, "netconf_params": { "$ref": "#/components/schemas/DeviceNetconfParams" } } } } }, "type": "object" }, "SwitchEditPortsInfoPostParams": { "additionalProperties": false, "type": "object", "properties": { "duplex": { "type": "string", "description": "Port duplex", "enum": [ "unknown", "half", "full", "disagree", "auto" ] }, "speed": { "type": "string", "description": "Port speed", "enum": [ "unknown", "auto", "auto_10_100M", "10M", "100M", "1G", "10G", "16G", "40G" ] }, "admin_status": { "type": "string", "description": "Port status", "enum": [ "up", "down", "testing", "unknown" ] }, "oper_status": { "type": "string", "description": "Port Link", "enum": [ "up", "down", "testing", "unknown" ] }, "description": { "type": "string", "description": "Description" } } }, "SwitchGetResponse": { "type": "object", "properties": { "device": { "enum": [ "cisco_snmp", "snmp_common" ], "type": "string" }, "hostname": { "type": "string" }, "id": { "type": "integer" }, "ip": { "type": "string" }, "status": { "type": "string", "enum": [ "ok", "fail", "in_progress" ] }, "name": { "type": "string" }, "note": { "type": "string" }, "rack": { "$ref": "#/components/schemas/RackSubquery" }, "location": { "$ref": "#/components/schemas/LocationSubquery" }, "location_id": { "type": "integer", "description": "Location identifier" }, "size": { "description": "Device size", "type": "integer" }, "last_update": { "description": "Date of the last device poll", "type": "string" }, "last_success_update": { "description": "Date of the last successful device poll", "type": "string" }, "unit": { "description": "Unit where device is located", "type": "integer" }, "total_port": { "description": "Total number of switch ports", "type": "integer" }, "using_port": { "description": "Number of ports in use", "type": "integer" }, "server_connection": { "description": "List of switch ports connected to server", "type": "array", "items": { "type": "object", "properties": { "connection_id": { "type": "integer", "description": "Connection identifier" }, "server_id": { "type": "integer", "description": "Server identifier" }, "port_id": { "type": "integer", "description": "Port identifier" }, "port_if_index": { "type": "string", "description": "Port If-index" } } } }, "snmp_params": { "$ref": "#/components/schemas/DeviceSnmpParams" }, "ssh_params": { "$ref": "#/components/schemas/DeviceSshParams" }, "netconf_params": { "$ref": "#/components/schemas/DeviceNetconfParams" }, "additional_info": { "description": "Additional switch info", "type": "object" } } }, "SwitchListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/SwitchGetResponse" }, "type": "array" } }, "type": "object" }, "SwitchPortEditPostParams": { "additionalProperties": false, "type": "object", "properties": { "duplex": { "enum": [ "unknown", "half", "full", "disagree", "auto" ], "type": "string" }, "speed": { "enum": [ "unknown", "auto", "auto_10_100M", "10M", "100M", "1G", "10G", "16G", "40G" ], "type": "string" }, "note": { "type": "string", "description": "Notes with information", "example": "Don't use 10G!" }, "vlan_id": { "type": "integer", "description": "The VLAN identifier (if is_trunk is true, then it is native VLAN)", "example": 571, "minimum": 1, "maximum": 4094 }, "is_trunk": { "type": "boolean", "description": "If equal true, then port work in trunk mode, else access mode" }, "trunk_members": { "description": "The VLAN identifiers", "type": "array", "items": { "type": "integer" } } } }, "SwitchPortGetResponse": { "properties": { "duplex": { "enum": [ "unknown", "half", "full", "disagree", "auto" ], "type": "string" }, "id": { "type": "integer" }, "if_index": { "type": "string" }, "speed": { "enum": [ "unknown", "auto", "auto_10_100M", "10M", "100M", "1G", "10G", "16G", "40G" ], "type": "string" }, "speed_type": { "enum": [ "unknown", "10M", "100M", "1G", "10G" ], "type": "string" }, "switch": { "type": "integer" }, "admin_status": { "enum": [ "up", "down", "testing", "unknown" ], "type": "string" }, "oper_status": { "enum": [ "up", "down", "testing", "unknown", "dormant", "notpresent", "lowerlayerdown" ], "type": "string" }, "connection_type": { "enum": [ "free", "connected", "service", "uplink" ], "type": "string" }, "connection_type_info": { "type": "string" }, "description": { "type": "string", "description": "Port description on switch", "example": "GigabitEthernet3/0/10" }, "connection_id": { "type": "string", "description": "Connection identifier" }, "note": { "type": "string", "description": "Notes with information", "example": "Don't use 10G!" }, "server": { "type": "object", "properties": { "id": { "type": "integer" }, "rack": { "type": "integer" }, "domain": { "type": "string" }, "name": { "type": "string" } } }, "vlan_id": { "type": "integer", "description": "The VLAN identifier (if is_trunk is true, then it is native VLAN)", "example": 571, "minimum": 1, "maximum": 4094 }, "is_trunk": { "type": "boolean", "description": "If equal true, then port work in trunk mode, else access mode" }, "trunk_members": { "description": "The VLAN identifiers and names", "type": "array", "items": { "type": "integer" } }, "do_not_collect_traffic": { "description": "Do not collect traffic passing through the switch port", "type": "boolean" }, "is_uplink": { "type": "boolean", "description": "Does port work in uplink mode. If the port is in uplink mode, it cannot be edited and connected to other devices" }, "is_service": { "type": "boolean", "description": "Does port work in service mode. If the port is service, it cannot be connected to other devices" } }, "type": "object" }, "SwitchPortListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/SwitchPortGetResponse" }, "type": "array" } }, "type": "object" }, "ChassisCreatePostParams": { "additionalProperties": false, "required": [ "name", "size", "server_slot_count", "unit" ], "type": "object", "properties": { "name": { "description": "Chassis name", "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^([\\w]+)([\\w\\- ]+)$", "example": "Multix4DE5" }, "size": { "description": "Chassis size", "type": "integer", "minimum": 1, "maximum": 10, "example": 4 }, "server_slot_count": { "description": "Number of slots in chassis for blade servers", "type": "integer", "minimum": 2, "maximum": 32, "example": 16 }, "note": { "description": "Comment", "type": "string" }, "unit": { "description": "Starting unit where device is located", "maximum": 99, "minimum": 1, "example": "1", "type": "integer" } } }, "ChassisEditPostParams": { "additionalProperties": false, "type": "object", "properties": { "name": { "description": "Chassis name", "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^([\\w]+)([\\w\\- ]+)$", "example": "Multix4DE5" }, "note": { "description": "Comment", "type": "string" } } }, "ChassisGetResponse": { "properties": { "id": { "type": "integer", "description": "Chassis identifier" }, "name": { "description": "Chassis name", "type": "string" }, "rack": { "description": "Rack", "type": "integer" }, "size": { "description": "Chassis size", "type": "number" }, "server_slot_count": { "description": "Number of slots in chassis for blade servers", "type": "integer" }, "note": { "description": "Comment", "type": "string" }, "unit": { "description": "Starting unit where chassis is located", "maximum": 99, "minimum": 1, "example": 1, "type": "integer" }, "used": { "description": "Number of slots in use", "type": "integer" }, "free": { "description": "Number of free slots", "type": "integer" }, "device_server": { "description": "Servers installed into the chassis", "items": { "properties": { "id": { "description": "Server identifier", "type": "integer" }, "name": { "description": "Server name", "type": "string" }, "slot": { "description": "Slot number", "type": "integer" }, "size": { "description": "Server size", "type": "number" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "ChassisListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/ChassisGetResponse" }, "type": "array" } }, "type": "object" }, "ChassisGetSlotsResponse": { "type": "object", "properties": { "list": { "type": "array", "description": "List of chassis slots with devices and sizes", "items": { "type": "object", "properties": { "slot": { "type": "integer", "description": "Slot number" }, "devices": { "type": "array", "nullable": true, "items": { "type": "object", "description": "Device that occupies the slot", "properties": { "id": { "type": "integer", "description": "Server id that occupies the slot" }, "name": { "type": "string", "description": "Server name", "example": "Server 2568" }, "size": { "type": "integer", "description": "Server size", "example": 1 }, "slot": { "type": "integer", "description": "Slot where Server is located" } } } } } } } } }, "CpuSocketCreatePostParams": { "additionalProperties": false, "properties": { "name": { "description": "CPU socket name", "example": "Socket SP3", "minLength": 1, "maxLength": 49, "pattern": "^([\\w]+)([\\w\\- ]+)$", "type": "string" }, "note": { "description": "Comment", "type": "string" } }, "required": [ "name" ], "type": "object" }, "CpuSocketGetResponse": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "note": { "type": "string" } }, "type": "object" }, "CpuSocketListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/CpuSocketGetResponse" }, "type": "array" } }, "type": "object" }, "UserCreatePostParams": { "additionalProperties": false, "properties": { "email": { "description": "User email", "example": "admin@example.com", "type": "string", "format": "email" }, "full_name": { "type": "string" }, "password": { "type": "string" }, "phone_number": { "type": "string" }, "role": { "type": "string", "enum": [ "@admin", "@user" ] } }, "required": [ "email", "password", "role" ], "type": "object" }, "UserGetResponse": { "properties": { "id": { "type": "integer" }, "email": { "type": "string" }, "server_count": { "type": "integer" }, "roles": { "description": "User roles array", "example": "[@user]", "type": "array", "items": { "type": "string", "example": "@user" } } }, "type": "object" }, "UserListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/UserGetResponse" }, "type": "array" } }, "type": "object" }, "PduCreatePostParams": { "additionalProperties": false, "required": [ "name", "ip", "device", "rack", "unit", "size" ], "type": "object", "properties": { "device": { "description": "Device handler", "type": "string" }, "ip": { "description": "PDU IP address", "example": "127.0.0.1", "format": "ipv4", "type": "string" }, "name": { "description": "PDU name", "example": "my key name", "pattern": "^[^ ]", "type": "string" }, "note": { "description": "Comment", "type": "string" }, "rack": { "description": "Rack", "example": "1", "type": "integer" }, "unit": { "description": "Starting unit where device is located", "maximum": 99, "minimum": 1, "example": "1", "type": "integer" }, "size": { "description": "PDU size in units", "maximum": 99, "minimum": 1, "example": "1", "type": "integer" }, "snmp_params": { "$ref": "#/components/schemas/DeviceSnmpParams" } } }, "PduEditPostParams": { "additionalProperties": false, "type": "object", "properties": { "ip": { "description": "PDU IP address", "example": "127.0.0.1", "format": "ipv4", "type": "string" }, "name": { "description": "PDU name", "example": "my key name", "pattern": "^[^ ]", "type": "string" }, "note": { "description": "Comment", "type": "string" }, "unit": { "description": "Starting unit where device is located", "maximum": 99, "minimum": 1, "example": "1", "type": "integer" }, "size": { "description": "PDU size in units", "maximum": 99, "minimum": 1, "example": "1", "type": "integer" }, "rack": { "description": "Rack", "example": "1", "type": "integer" }, "snmp_params": { "$ref": "#/components/schemas/DeviceSnmpParams" } } }, "PduPortEditPostParams": { "additionalProperties": false, "type": "object", "properties": { "note": { "description": "Comment", "type": "string" } } }, "PduGetResponse": { "type": "object", "properties": { "id": { "description": "PDU device identifier", "type": "integer" }, "device": { "description": "PDU handler type", "type": "string" }, "ip": { "description": "PDU IP address", "type": "string" }, "status": { "type": "string", "description": "Device status: * ok - device is ok * fail - lost connection with device * process_status - device poll in progress\n", "enum": [ "ok", "fail", "process_status" ] }, "status_info": { "type": "object", "description": "Detailed description of issues with device" }, "name": { "description": "Device name", "type": "string" }, "note": { "description": "Comment", "type": "string" }, "rack": { "$ref": "#/components/schemas/RackSubquery" }, "location": { "$ref": "#/components/schemas/LocationSubquery" }, "location_id": { "type": "integer", "description": "Location identifier" }, "size": { "description": "Device size", "type": "integer" }, "unit": { "description": "Unit where device is located", "type": "integer" }, "last_update": { "description": "Date of the last device poll", "type": "string" }, "last_success_update": { "description": "Date of the last successful device poll", "type": "string" }, "total_port": { "description": "Total number of device ports", "type": "integer" }, "using_port": { "description": "Ports in use", "type": "integer" }, "snmp_params": { "$ref": "#/components/schemas/DeviceSnmpParams" } } }, "PduListResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/components/schemas/PduGetResponse" } } } }, "PduPortGetResponse": { "properties": { "id": { "description": "Port identifier", "type": "integer" }, "identity": { "description": "Port identifier in PDU", "type": "integer" }, "pdu": { "description": "PDU identifier", "type": "integer" }, "power_status": { "description": "PDU port status: * up - port enabled * down - port disabled * unknown - unknown port status (does not correspond to up/down)\n", "enum": [ "unknown", "up", "down" ], "type": "string" }, "connection_type": { "description": "Port connection status * free - available * connected - connected to server * service - service port\n", "enum": [ "free", "connected", "service" ], "type": "string" }, "connection_type_info": { "description": "Additional information about service connections", "type": "string" }, "note": { "description": "Comment to port", "type": "string" }, "server": { "type": "object", "description": "Server connected to port", "properties": { "id": { "description": "Server identifier", "type": "integer" }, "name": { "description": "Server name", "type": "string" }, "rack": { "description": "Rack where server is located", "type": "integer" }, "connection_id": { "description": "Connection identifier", "type": "integer" } } } }, "type": "object" }, "PduPortListResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/components/schemas/PduPortGetResponse" } } } }, "IppoolGetResponse": { "properties": { "id": { "type": "integer" }, "is_public": { "description": "Userspace where the pool is located, is public", "type": "boolean" }, "location": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "note": { "type": "string" }, "total_ip": { "description": "Number of all addresses in the pool that can be allocated", "type": "string" }, "userspace": { "type": "integer" }, "using_ip": { "description": "Number of allocated IP addresses in the pool", "type": "string" } }, "type": "object" }, "IppoolListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/IppoolGetResponse" }, "type": "array" } }, "type": "object" }, "IpnetGetResponse": { "properties": { "family": { "description": "Values 2 and 10 are used for indication IPv4 and IPv6 correspondingly", "enum": [ 2, 10 ], "type": "integer" }, "gateway": { "type": "string" }, "id": { "type": "integer" }, "is_public": { "description": "Userspace where the pool is located, is public", "type": "boolean" }, "location": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "mask": { "type": "integer" }, "name": { "type": "string" }, "note": { "type": "string" }, "size": { "type": "string" }, "total_ip": { "description": "Number of all network IP addresses that can be allocated", "type": "string" }, "userspace": { "type": "integer" }, "using_ip": { "description": "Number of allocated addresses", "type": "string" }, "vlan": { "type": "string" } }, "type": "object" }, "IpnetListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/IpnetGetResponse" }, "type": "array" } }, "type": "object" }, "ServerOwnerPostParams": { "additionalProperties": false, "properties": { "owner": { "description": "Server owner user ID", "example": 42, "type": "integer" } }, "type": "object" }, "RackCreatePostParams": { "additionalProperties": false, "properties": { "name": { "description": "Rack name", "example": "my key name", "pattern": "^[^ ]", "type": "string" }, "note": { "description": "Comment", "type": "string" }, "size": { "description": "Rack size", "maximum": 99, "minimum": 1, "type": "integer" } }, "required": [ "name", "size" ], "type": "object" }, "RackEditPostParams": { "additionalProperties": false, "properties": { "name": { "description": "Rack name", "example": "my key name", "pattern": "^[^ ]", "type": "string" }, "note": { "description": "Comment", "type": "string" } }, "type": "object" }, "RackGetResponse": { "properties": { "device_server": { "description": "Servers installed into the rack", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "unit": { "type": "integer" }, "size": { "type": "number" } }, "type": "object" }, "type": "array" }, "id": { "type": "integer" }, "location": { "$ref": "#/components/schemas/LocationSubquery" }, "name": { "type": "string" }, "reserved": { "description": "Number of reserved units", "type": "integer" }, "size": { "type": "integer" }, "used": { "description": "Number of units in use", "format": "float", "type": "number" }, "free": { "description": "Number of free units", "format": "float", "type": "number" }, "device_switch": { "description": "List of switches", "type": "array", "items": { "properties": { "id": { "type": "integer", "description": "Switch identifier" }, "name": { "type": "string", "description": "Switch name" }, "unit": { "type": "integer", "description": "Unit" }, "size": { "type": "string", "description": "Size" } } } }, "device_pdu": { "description": "List of PDU", "type": "array", "items": { "properties": { "id": { "type": "integer", "description": "PDU identifier" }, "name": { "type": "string", "description": "PDU name" }, "unit": { "type": "integer", "description": "Unit" }, "size": { "type": "string", "description": "Size" } } } }, "device_chassis": { "description": "List of Chassis", "type": "array", "items": { "properties": { "id": { "type": "integer", "description": "Chassis identifier" }, "name": { "type": "string", "description": "Chassis name" }, "unit": { "type": "integer", "description": "Unit" }, "size": { "type": "string", "description": "Size" } } } } }, "type": "object" }, "RackListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/RackGetResponse" }, "type": "array" } }, "type": "object" }, "RackGetUnitsResponse": { "type": "object", "properties": { "list": { "type": "array", "description": "List of rack units with devices and sizes", "items": { "type": "object", "properties": { "unit": { "type": "integer", "description": "Unit number" }, "busy_space": { "format": "float", "type": "number", "description": "How much space is occupied in unit, 0.0 - unit available, 1.0 - unit is in use\n" }, "devices": { "type": "array", "items": { "type": "object", "description": "Device that occupies the unit", "properties": { "id": { "type": "integer", "description": "Device id that occupies the unit" }, "name": { "type": "string", "description": "Device name", "example": "Server 2568" }, "size": { "format": "float", "type": "number", "description": "Device size", "example": 1.5 }, "unit": { "type": "integer", "description": "Unit where device is located" }, "type": { "type": "string", "description": "Device type that occupies the unit", "example": "dci_server" } } } } } } } } }, "LocationCreatePostParams": { "additionalProperties": false, "properties": { "geolocation": { "description": "Location address", "example": "1st Street, 25", "type": "string" }, "name": { "description": "Location name", "example": "DataCenter2", "pattern": "^[^ ]", "type": "string" }, "password": { "description": "Password", "type": "string" }, "ssh_address": { "description": "SSH access IP address", "example": "127.0.0.1", "format": "ipv4", "type": "string" }, "ssh_port": { "description": "SSH access port", "example": 22, "maximum": 65535, "minimum": 1, "type": "integer" }, "ssh_user": { "description": "Username for SSH access", "example": "root", "minLength": 1, "pattern": "^[^ ]", "type": "string" } }, "required": [ "name", "ssh_address", "ssh_port", "ssh_user" ], "type": "object" }, "LocationEditPostParams": { "additionalProperties": false, "properties": { "geolocation": { "description": "Location address", "example": "1st Street, 25", "type": "string" }, "name": { "description": "Location name", "example": "my key name", "pattern": "^[^ ]", "type": "string" }, "password": { "description": "SSH access password", "type": "string" }, "ssh_address": { "description": "SSH access IP address", "example": "127.0.0.1", "format": "ipv4", "type": "string" }, "ssh_port": { "description": "SSH access port", "example": 22, "maximum": 65535, "minimum": 1, "type": "integer" }, "ssh_user": { "description": "SSH access username", "example": "root", "minLength": 1, "pattern": "^[^ ]", "type": "string" } }, "type": "object" }, "LocationGetResponse": { "properties": { "geolocation": { "description": "Location address", "example": "1st Street, 25", "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "params_dhcp": { "description": "dhcp parameters", "properties": { "interfaces_4": { "description": "dhcp v4 interfaces", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "params_nginx": { "description": "Nginx parameters", "properties": { "addresses": { "description": "List of nginx addresses", "items": { "type": "string" }, "type": "array" }, "port": { "description": "Port", "type": "integer" } }, "type": "object" }, "params_redis": { "description": "Redis parameters", "properties": { "password": { "description": "Password", "type": "string" }, "port": { "description": "Port", "type": "integer" } }, "type": "object" }, "setup_info": { "description": "Parameters for location configuration", "properties": { "addresses": { "description": "Addresses list", "items": { "type": "string" }, "type": "array" }, "interfaces": { "description": "Interfaces for dhcp configuration", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "ssh_address": { "description": "SSH access IP address", "type": "string" }, "ssh_port": { "description": "SSH access port", "type": "integer" }, "ssh_user": { "description": "SSH access username", "type": "string" }, "status": { "description": "Status", "enum": [ "created", "check_failed", "need_setup", "setup", "ok", "setup_failed" ], "type": "string" }, "userspace": { "description": "Userspace ID in IPmgr6 for pools and networks of this location", "type": "integer" }, "dhcp4_conf": { "type": "object", "description": "kea-dhcp4 configuration file" }, "docker_compose": { "description": "Compose file that was used for location configuration (internal only)", "type": "string" } }, "type": "object" }, "LocationListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/LocationGetResponse" }, "type": "array" } }, "type": "object" }, "LocationSetupPostParams": { "additionalProperties": false, "properties": { "dhcp": { "type": "object", "description": "Dhcp configuration parameters", "properties": { "interfaces_4": { "description": "Dhcp v4 configuration interfaces", "items": { "type": "string" }, "type": "array" } } }, "nginx": { "description": "Nginx configuration parameters", "properties": { "addresses": { "description": "IP addresses on which nginx will listen", "items": { "example": "127.0.0.1", "format": "ipv4", "type": "string" }, "type": "array" } }, "type": "object" } }, "type": "object" }, "LocationMessagePostParams": { "additionalProperties": true, "properties": { "stream": { "type": "string", "description": "Thread where the message was published" }, "message": { "description": "Message", "type": "object" } }, "required": [ "stream", "message" ], "type": "object" }, "GetLicenseResponse": { "type": "object", "properties": { "device_limit_exceeded": { "description": "Device limit has been exceeded", "example": true, "type": "boolean" }, "device_limit": { "description": "Maximum number of devices", "example": 250, "type": "integer" }, "total_devices": { "description": "Current number of devices", "example": 117, "type": "integer" }, "limits": { "type": "object", "properties": { "used": { "type": "object", "properties": { "devices": { "type": "integer", "description": "Current number of devices (4 Auth)" } } } } }, "license": { "description": "License information", "type": "object", "properties": { "time_to_end": { "description": "time to license expiration date", "example": 1568739759, "type": "integer" }, "expiration_date": { "description": "license expiration date", "example": 1780725966, "type": "integer" }, "user_id": { "description": "User ID", "example": 42, "type": "integer" }, "metric_id": { "description": "User ID hash(md5) of the license token", "type": "string" } } } } }, "ServerToPduPostParams": { "additionalProperties": false, "type": "object", "required": [ "server_id", "pdu_port_id" ], "properties": { "server_id": { "description": "Server identifier", "example": 13, "type": "integer" }, "pdu_port_id": { "description": "PDU port identifier", "example": 2, "type": "integer" } } }, "LocationVlansListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/VlanGetResponse" }, "type": "array" } }, "type": "object" }, "VlanCreatePostParams": { "additionalProperties": false, "properties": { "id": { "description": "The VLAN unique identifier", "type": "integer", "minimum": 1, "maximum": 4094 }, "name": { "description": "The VLAN name", "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^[\\w\\-]+$", "example": "vlan-1" }, "note": { "description": "The VLAN comment", "maxLength": 1500, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "VlanEditPostParams": { "additionalProperties": false, "properties": { "name": { "description": "The VLAN name", "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^[\\w\\-]+$", "example": "vlan 1" }, "note": { "description": "The VLAN comment", "maxLength": 1500, "type": "string" } }, "type": "object" }, "VlanGetResponse": { "type": "object", "properties": { "id": { "description": "The VLAN unique identifier", "type": "integer" }, "location_id": { "description": "The VLAN unique identifier", "type": "integer" }, "name": { "description": "The VLAN name", "type": "string" }, "note": { "description": "The VLAN comment", "type": "string" }, "members_count": { "description": "The VLAN members count", "type": "integer" } } }, "VlanMembersGetResponse": { "type": "object", "properties": { "id": { "description": "The VLAN member port id", "type": "integer" }, "connection_type": { "enum": [ "free", "connected", "service", "uplink" ], "type": "string", "description": "The connection type" }, "connection_type_info": { "type": "string", "description": "The connection type information" }, "connection_id": { "type": "string", "description": "The connection identifier" }, "admin_status": { "enum": [ "up", "down", "testing", "unknown" ], "type": "string", "description": "The port administrative status" }, "oper_status": { "enum": [ "up", "down", "testing", "unknown", "dormant", "notpresent", "lowerlayerdown" ], "type": "string", "description": "The port operation status" }, "speed": { "enum": [ "unknown", "auto", "auto_10_100M", "10M", "100M", "1G", "10G", "16G", "40G" ], "type": "string", "description": "The port speed" }, "duplex": { "enum": [ "unknown", "half", "full", "disagree", "auto" ], "type": "string", "description": "The port duplex" }, "note": { "type": "string", "description": "The port notes with additional information" }, "description": { "type": "string", "description": "The port description on switch" }, "is_trunk": { "type": "boolean", "description": "Is port work in trunk mode" }, "trunk_members": { "description": "The VLAN identifiers and names", "type": "array", "items": { "type": "integer" } }, "is_uplink": { "type": "boolean", "description": "Does port work in uplink mode. If the port is in uplink mode, it cannot be edited and connected to other devices." }, "is_service": { "type": "boolean", "description": "Does port work in service mode. If the port is service, it cannot be connected to other devices" }, "do_not_collect_traffic": { "description": "Do not collect traffic passing through the switch port", "type": "boolean" }, "vlan": { "type": "object", "properties": { "vlan_id": { "type": "integer", "description": "The VLAN unique identifier" }, "vlan_name": { "type": "string", "description": "The unique name of a VLAN" } }, "description": "The port VLAN information (If the port is trunk - it is native VLAN)" }, "server": { "type": "object", "properties": { "id": { "type": "integer", "description": "The server unique identifier" }, "name": { "type": "string", "description": "The server name" } }, "description": "The server information" }, "switch": { "type": "object", "properties": { "id": { "type": "integer", "description": "The switch unique identifier" }, "name": { "type": "string", "description": "The switch name" } }, "description": "The switch information" } } }, "IpCreatePostParams": { "additionalProperties": false, "properties": { "domain": { "description": "Hostname", "format": "hostname", "minLength": 1, "type": "string" }, "family": { "description": "Address type", "enum": [ "ipv4", "ipv6" ], "type": "string" }, "ip_name": { "anyOf": [ { "format": "ipv4" }, { "format": "ipv6" } ], "description": "IP address that will be allocated", "type": "string" }, "ip_net": { "description": "Network ID in IPmanager 6", "type": "integer" }, "ip_pool": { "description": "IP pool in IPmanager 6", "type": "integer" }, "set_as_main_ipv4": { "description": "Set IP as the primary IP address of the server", "type": "boolean" }, "userspace": { "description": "Userspace ID in IPmanager 6", "type": "integer" } }, "required": [ "domain", "family" ], "type": "object" }, "IpEditPostParams": { "additionalProperties": false, "properties": { "domain": { "description": "Hostname", "format": "hostname", "minLength": 1, "type": "string" } }, "type": "object" }, "IpGetResponse": { "properties": { "domain": { "type": "string" }, "family": { "enum": [ "ipv4", "ipv6" ], "type": "string" }, "gateway": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "network": { "type": "string" }, "server": { "type": "string" }, "status": { "enum": [ "allocating", "ok", "fail", "allocation_fail", "in_progress", "deleting" ], "type": "string" }, "status_info": { "type": "object" } }, "type": "object" }, "IpListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/IpGetResponse" }, "type": "array" } }, "type": "object" }, "ServerToSwitchPostParams": { "additionalProperties": false, "properties": { "server_id": { "description": "Server ID", "example": 13, "type": "integer" }, "switch_port_id": { "description": "Switch port ID", "example": 2, "type": "integer" }, "do_not_collect_traffic": { "description": "Do not collect traffic passing through the switch port", "type": "boolean" } }, "required": [ "server_id", "switch_port_id" ], "type": "object" }, "SwitchConnectionGetResponse": { "type": "object", "properties": { "server": { "type": "integer", "description": "Server ID", "example": 25 }, "id": { "type": "integer", "description": "Connection ID", "example": 42 }, "switch": { "type": "integer", "description": "Switch ID", "example": 33 }, "switch_port": { "type": "integer", "description": "Switch port ID", "example": 15 }, "if_index": { "type": "string", "description": "Interface index", "example": 10105 }, "speed": { "type": "string", "description": "Port speed", "enum": [ "unknown", "auto", "auto_10_100M", "10M", "100M", "1G", "10G", "16G", "40G" ] }, "duplex": { "type": "string", "description": "Duplex", "enum": [ "unknown", "half", "full", "disagree", "auto" ] }, "admin_status": { "type": "string", "description": "Admin status", "enum": [ "up", "down", "testing", "unknown" ] }, "oper_status": { "type": "string", "description": "Operating status", "enum": [ "up", "down", "testing", "unknown", "dormant", "notpresent", "lowerlayerdown" ] }, "description": { "type": "string", "description": "Port description", "example": "GigabitEthernet1/0/5" }, "do_not_collect_traffic": { "description": "Do not collect traffic passing through the switch port", "type": "boolean" } } }, "SwitchConnectionListResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/components/schemas/SwitchConnectionGetResponse" } } } }, "OperationGetResponse": { "additionalProperties": true, "properties": { "id": { "type": "integer" }, "status": { "type": "string" }, "status_info": { "type": "object" }, "auth_id": { "type": "string" }, "os_template": { "type": "integer" }, "progress_info": { "type": "string" }, "type": { "type": "string", "description": "Operation type" } }, "type": "object" }, "ServerCreatePostParams": { "additionalProperties": false, "required": [ "name", "mac", "rack", "unit", "platform" ], "type": "object", "properties": { "mac": { "description": "MAC address", "example": "AA:BB:CC:DD:EE:FF", "pattern": "^(([A-F0-9a-f]){2}(:|-)){5}([A-F0-9a-f]){2}$", "type": "string" }, "name": { "description": "Server name", "example": "Server 1", "minLength": 1, "maxLength": 49, "pattern": "^([\\w]+)([\\w\\- ]+)$", "type": "string" }, "note": { "description": "Comment", "type": "string" }, "rack": { "description": "Rack", "example": "1", "type": "integer" }, "unit": { "description": "Starting unit where server is located", "maximum": 99, "minimum": 1, "type": "integer" }, "os_template": { "type": "object", "description": "OS installed on server", "properties": { "id": { "type": "integer", "description": "OS template ID in DCI6 (if any)" }, "name": { "type": "string", "description": "OS name" }, "tags": { "type": "array", "description": "List of template tags", "example": [ "centos", "linux", "unix", "centos6" ], "items": { "type": "string" } } } }, "platform": { "description": "Server platforms ID", "minimum": 1, "type": "integer" } } }, "BladeServerCreatePostParams": { "additionalProperties": false, "required": [ "name", "mac", "chassis", "slot", "platform" ], "type": "object", "properties": { "mac": { "description": "MAC address", "example": "AA:BB:CC:DD:EE:FF", "pattern": "^(([A-F0-9a-f]){2}(:|-)){5}([A-F0-9a-f]){2}$", "type": "string" }, "name": { "description": "Server name", "example": "my key name", "pattern": "^[^ ]", "type": "string" }, "note": { "description": "Comment", "type": "string" }, "chassis": { "description": "Chassis", "example": 1, "type": "integer" }, "slot": { "description": "Starting slot where blade server is located", "maximum": 99, "minimum": 1, "type": "integer" }, "os_template": { "type": "object", "description": "OS installed on server", "properties": { "id": { "type": "integer", "description": "OS template ID in DCI6 (if any)" }, "name": { "type": "string", "description": "OS name" }, "tags": { "type": "array", "description": "List of template tags", "example": [ "centos", "linux", "unix", "centos6" ], "items": { "type": "string" } } } }, "platform": { "description": "Server platforms ID", "minimum": 1, "type": "integer" } } }, "ServerEditPostParams": { "additionalProperties": false, "properties": { "domain": { "description": "Hostname", "example": "my.server", "format": "hostname", "minLength": 1, "type": "string" }, "mac": { "description": "MAC address", "example": "AA:BB:CC:DD:EE:FF", "pattern": "^(([A-F0-9a-f]){2}(:|-)){5}([A-F0-9a-f]){2}$", "type": "string" }, "name": { "description": "Server name", "example": "my key name", "pattern": "^[^ ]", "type": "string" }, "note": { "description": "Comment", "type": "string" }, "user_note": { "description": "User comments", "type": "string" }, "unit": { "description": "Starting unit where the server is located", "maximum": 99, "minimum": 1, "type": "integer" }, "slot": { "description": "Starting slot where blade server is located", "maximum": 99, "minimum": 1, "type": "integer" }, "main_ipv4": { "description": "Primary IPv4 address of the server", "minimum": 1, "type": "integer" } }, "type": "object" }, "DiagErrorDetail": { "additionalProperties": false, "type": "object", "properties": { "type": { "type": "string" }, "info": { "type": "string" } } }, "ServerGetResponse": { "properties": { "operation": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" }, "status_info": { "type": "object" }, "progress_info": { "description": "Operation progress information", "type": "array", "items": { "type": "object" } } } }, "domain": { "type": "string" }, "id": { "type": "integer" }, "os_template": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "hardware_info": { "type": "object", "description": "Information about server equipment received during diagnostics" }, "configuration": { "type": "string", "description": "Automatically generated server configuration" }, "state": { "type": "string", "description": "Server status: * suspending - Server operation has been suspended (all switch ports connected to the server were powered off) * suspended - Suspended(all switch ports connected to the server were powered off) * suspend_error - Error suspending sever (failed to power off all switch ports connected to the server) * resuming - Enable server operation (all switch ports connected to the server were powered on) * ok - Ready to work * resume_error - Error powering on the server(failed to power on all switch ports connected to the server)\n", "enum": [ "suspending", "suspended", "suspend_error", "resuming", "ok", "resume_error" ] }, "state_info": { "type": "string", "description": "Information about server status" }, "ip": { "items": { "properties": { "domain": { "type": "string" }, "family": { "enum": [ "ipv4", "ipv6" ], "type": "string" }, "gateway": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "network": { "type": "string" }, "status": { "enum": [ "allocating", "ok", "fail", "allocation_fail", "in_progress", "deleting" ], "type": "string" }, "status_info": { "type": "object" } }, "type": "object" }, "type": "array" }, "switch_connection": { "description": "List of switch ports connected to the server", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Port identifier" }, "switch": { "type": "integer", "description": "Switch identifier" }, "connection_id": { "type": "integer", "description": "Connection identifier" }, "description": { "type": "string", "description": "Port description" }, "admin_status": { "$ref": "#/components/schemas/eAdminStatus" }, "oper_status": { "$ref": "#/components/schemas/eOperStatus" } } } }, "pdu_connection": { "description": "PDU port identifier connected to the server", "type": "object", "properties": { "port_id": { "type": "integer", "description": "Port identifier" }, "port_identity": { "type": "string", "description": "Port identifier in PDU" }, "pdu_id": { "type": "integer", "description": "PDU identifier" }, "pdu_name": { "type": "string", "description": "PDU name" }, "connection_id": { "type": "integer", "description": "Connection identifier" }, "power_status": { "type": "string", "description": "Port power status * up - port enabled * down - port disabled * unknown - unknown port status (does not correspond to up/down)\n", "enum": [ "up", "down", "unknown" ] } } }, "ipmi": { "type": "object", "properties": { "address": { "description": "IPMI IP address", "type": "string" }, "id": { "type": "integer" }, "status": { "enum": [ "on", "off", "unknown", "in_progress" ], "type": "string" }, "status_info": { "type": "object" }, "type": { "description": "IPMI type", "enum": [ "IPMI v1.5/v2", "IPMI v2(lanplus)" ], "type": "string" }, "web_url": { "description": "IPMI web-interface URL", "format": "uri", "type": "string" } } }, "location": { "$ref": "#/components/schemas/LocationSubquery" }, "location_id": { "type": "integer", "description": "Location identifier" }, "mac": { "type": "string" }, "main_ipv4": { "description": "Primary IPv4 address (ID). This IP will be used for OS deployment", "type": "integer" }, "name": { "type": "string" }, "platform": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "size": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" }, "rack": { "$ref": "#/components/schemas/RackSubquery" }, "unit": { "description": "Starting unit where server is located", "type": "integer" }, "chassis": { "$ref": "#/components/schemas/ChassisSubquery" }, "slot": { "description": "Starting slot where blade server is located", "type": "integer" }, "owner": { "type": "object", "description": "Information about the server owner", "properties": { "id": { "type": "integer", "description": "Server owner identifier" }, "email": { "type": "string", "description": "Server owner email" } } }, "owner_email": { "type": "string", "description": "Server owner email" }, "diag_error": { "type": "array", "items": { "$ref": "#/components/schemas/DiagErrorDetail" } } }, "type": "object" }, "ServerListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/ServerGetResponse" }, "type": "array" } }, "type": "object" }, "ServersConfigurationGetResponse": { "additionalProperties": false, "properties": { "list": { "items": { "properties": { "configuration": { "type": "string", "description": "Server configuration", "example": "i9-9900K-64Gb-2x1024NVMe" }, "free_server_count": { "type": "integer", "description": "Number of available servers with corresponding configuration", "example": 42 } } }, "type": "array" } }, "type": "object" }, "IpmiCreatePostParams": { "additionalProperties": false, "properties": { "address": { "description": "IPMI address", "type": "string", "format": "ipv4" }, "password": { "description": "Password", "type": "string" }, "type": { "description": "IPMI type", "enum": [ "IPMI v1.5/v2", "IPMI v2(lanplus)" ], "type": "string" }, "user": { "description": "Username", "maxLength": 15, "type": "string" }, "web_url": { "description": "IPMI web-interface URL", "format": "uri", "type": "string" } }, "required": [ "address", "user", "password", "type" ], "type": "object" }, "IpmiEditPostParams": { "additionalProperties": false, "properties": { "address": { "description": "IPMI address", "type": "string" }, "password": { "description": "Password", "type": "string" }, "type": { "description": "IPMI type", "enum": [ "IPMI v1.5/v2", "IPMI v2(lanplus)" ], "type": "string" }, "user": { "description": "Username", "maxLength": 15, "type": "string" }, "web_url": { "description": "IPMI web-interface URL", "format": "uri", "type": "string" } }, "type": "object" }, "IpmiGetResponse": { "properties": { "address": { "type": "string" }, "id": { "type": "integer" }, "password": { "type": "string" }, "server": { "type": "string" }, "server_id": { "type": "integer" }, "status": { "enum": [ "on", "off", "unknown", "in_progress" ], "type": "string" }, "last_update": { "description": "Date of the last device poll", "type": "string" }, "last_success_update": { "description": "Date of the last successful device poll", "type": "string" }, "status_info": { "type": "object" }, "type": { "enum": [ "IPMI v1.5/v2", "IPMI v2(lanplus)" ], "type": "string" }, "user": { "type": "string" }, "web_url": { "description": "IPMI web-interface URL", "type": "string" }, "mc_info": { "description": "The IPMI manufacture information", "type": "string" } }, "type": "object" }, "IpmiListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/IpmiGetResponse" }, "type": "array" } }, "type": "object" } }, "requestBodies": { "OsTemplateSetupPostParams": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OsTemplateSetupPostParams" } } } }, "EmptyRequest": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } } } }, "security": [ { "cookieAuth": [], "headerHost": [] } ], "paths": { "/platform": { "get": { "operationId": "platform_get", "responses": { "200": { "description": "Platforms have been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformListResponse" } } } }, "default": { "description": "Error receiving list of platforms", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive all platforms", "tags": [ "platform" ] }, "post": { "operationId": "platform_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformCreatePostParams" } } } }, "responses": { "200": { "description": "Platform has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error creating platform", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Create platform", "tags": [ "platform" ] } }, "/platform/{platform_id}": { "get": { "operationId": "platform_id_get", "parameters": [ { "description": "Platform unique identifier", "in": "path", "name": "platform_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Platform has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformGetResponse" } } } }, "default": { "description": "Platform not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive platform", "tags": [ "platform" ] }, "post": { "operationId": "platform_id_post", "parameters": [ { "description": "Platform unique identifier", "in": "path", "name": "platform_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformEditPostParams" } } } }, "responses": { "200": { "description": "Platform has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error saving platform", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Edit platform", "tags": [ "platform" ] }, "delete": { "operationId": "platform_id_delete", "parameters": [ { "description": "Platform unique identifier", "in": "path", "name": "platform_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Platform has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deleting platform", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Delete platform", "tags": [ "platform" ] } }, "/location/{location_id}/os_template/download": { "post": { "operationId": "location_id_os_template_download_post", "parameters": [ { "description": "Location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/OsTemplateSetupPostParams" }, "responses": { "200": { "description": "OS templates have been uploaded to location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskOnlySchema" } } } }, "default": { "description": "Error uploading OS templates to location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Uploading OS templates to location", "tags": [ "os_template" ] } }, "/location/{location_id}/os_template/remove": { "post": { "operationId": "location_id_os_template_remove_post", "parameters": [ { "description": "Location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/OsTemplateSetupPostParams" }, "responses": { "200": { "description": "OS templates have been deleted from location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskOnlySchema" } } } }, "default": { "description": "Error deleting OS template from location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Delete OS templates from location", "tags": [ "os_template" ] } }, "/os_template": { "get": { "operationId": "os_template_get", "responses": { "200": { "description": "List of OS templates has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OsTemplateListResponse" } } } }, "default": { "description": "Error receiving a list of OS templates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive list of OS templates", "tags": [ "os_template" ] } }, "/os_template/check": { "post": { "operationId": "os_template_check_post", "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "List of OS templates has been updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskOnlySchema" } } } }, "default": { "description": "Error updating list of OS templates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Check list of OS templates", "tags": [ "os_template" ] } }, "/os_template/{os_template_id}": { "get": { "operationId": "os_template_id_get", "parameters": [ { "description": "The OS template unique identifier", "in": "path", "name": "os_template_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OS template information has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OsTemplateGetResponse" } } } }, "default": { "description": "Error receiving OS template information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive OS template information", "tags": [ "os_template" ] }, "post": { "operationId": "os_template_id_post", "parameters": [ { "description": "The OS template unique identifier", "in": "path", "name": "os_template_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OsTemplateEditParams" } } } }, "responses": { "200": { "description": "The OS template settings has been changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "The error changing OS template settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "The OS template settings changing", "tags": [ "os_template" ] } }, "/server/{server_id}/operation_cancel": { "post": { "operationId": "server_id_operation_cancel", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Operation has been cancelled successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error cancelling operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Cancel operation", "tags": [ "server", "operation" ] } }, "/server/{server_id}/operation_finish": { "post": { "operationId": "server_id_operation_finish", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerOperationFinishPostParams" } } } }, "responses": { "200": { "description": "Operation has been completed successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error completing operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Complete operation", "tags": [ "server", "operation" ] } }, "/server/{server_id}/operation_fail": { "post": { "operationId": "server_id_operation_fail", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerOperationFailPostParams" } } } }, "responses": { "200": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error failing operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Fail operation", "tags": [ "server", "operation" ] } }, "/server/{server_id}/operation_os": { "post": { "operationId": "server_id_operation_os", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerOperationOsPostParams" } } } }, "responses": { "200": { "description": "Operation has been started successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error starting operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Start operation", "tags": [ "server", "operation" ] } }, "/server/{server_id}/operation_diag": { "post": { "operationId": "server_id_operation_diag", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerOperationDiagPostParams" } } } }, "responses": { "200": { "description": "Diagnostics has been started successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error starting diagnostics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Start diagnostics", "tags": [ "server", "operation" ] } }, "/server/{server_id}/operation_rescue": { "post": { "operationId": "server_id_operation_rescue", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerOperationRescuePostParams" } } } }, "responses": { "200": { "description": "Rescue has been started successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error starting rescue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Start rescue", "tags": [ "server", "operation" ] } }, "/server/{server_id}/operation_rescue_ready": { "post": { "operationId": "server_id_operation_rescue_ready", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Operation rescue has been ready", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error rescue ready operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Handler does the last restore operation to the ready status", "tags": [ "server", "operation" ] } }, "/operation/{operation_id}": { "get": { "operationId": "operation_id_get", "parameters": [ { "description": "Operation unique identifier", "in": "path", "name": "operation_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Operation has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationGetResponse" } } } }, "default": { "description": "Operation not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive operation information", "tags": [ "operation" ] } }, "/server/{server_id}/operation_clear_hdd": { "post": { "operationId": "server_id_operation_clear_hdd", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerOperationClearHddPostParams" } } } }, "responses": { "200": { "description": "Server disk cleanup has been started", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error starting server disk cleanup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Start server disk cleanup", "tags": [ "server", "operation" ] } }, "/setup": { "post": { "operationId": "setup_post", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SetupPostParams" }, { "$ref": "#/components/schemas/BoxSetupPostParams" } ] } } } }, "responses": { "200": { "description": "Location has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTasksIdSchema" } } } }, "default": { "description": "Error creating location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Create first location", "tags": [ "location", "common" ] } }, "/info": { "get": { "operationId": "info_get", "responses": { "200": { "description": "DCI6 information and status have been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoGetResponse" } } } }, "default": { "description": "Error receiving information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive the panel status information with user permissions", "tags": [ "location", "common" ] } }, "/current_user/auth_setting/{name}": { "post": { "operationId": "user_auth_setting_post", "summary": "Edit description of the configuration by its name for the current user", "tags": [ "common" ], "parameters": [ { "description": "Parameter name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsParams" } } } }, "responses": { "200": { "description": "Configuration description has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error editing configuration description", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "get": { "operationId": "user_auth_setting_get", "summary": "Receive configuration description by its name for the current user", "tags": [ "common" ], "parameters": [ { "description": "Parameter name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Configuration description has been received successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsParams" } } } }, "default": { "description": "Error receiving configuration description", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/data_extractor": { "get": { "operationId": "data_extractor_get", "responses": { "200": { "description": "Statistics has been collected and sent successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } }, "default": { "description": "Error collecting and sending statistics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Collect and send statistics", "tags": [ "common" ] } }, "/update": { "post": { "operationId": "update", "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Panel update has been started", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Failed to start panel update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Panel update", "tags": [ "update" ] } }, "/supported_switch": { "get": { "operationId": "supported_switch_get", "responses": { "200": { "description": "List of supported switches has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedDevicesListResponse" } } } }, "default": { "description": "Error receiving list of supported switches", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "List of supported switches", "tags": [ "switch" ] } }, "/switch": { "get": { "operationId": "switch_get", "responses": { "200": { "description": "Switches have been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchListResponse" } } } }, "default": { "description": "Error receiving list of switches", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive information about switches", "tags": [ "switch" ] }, "post": { "operationId": "switch_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchCreatePostParams" } } } }, "responses": { "200": { "description": "Switch has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error saving switch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Create switch", "tags": [ "switch" ] } }, "/switch/{switch_id}": { "delete": { "operationId": "switch_id_delete", "parameters": [ { "description": "Switch unique identifier", "in": "path", "name": "switch_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Switch has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deleting switch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Delete switch", "tags": [ "switch" ] }, "get": { "operationId": "switch_id_get", "parameters": [ { "description": "Switch unique identifier", "in": "path", "name": "switch_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Switch has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchGetResponse" } } } }, "default": { "description": "Switch not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive information about switch", "tags": [ "switch" ] }, "post": { "operationId": "switch_id_post", "parameters": [ { "description": "Switch unique identifier", "in": "path", "name": "switch_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchEditPostParams" } } } }, "responses": { "200": { "description": "Switch has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error saving switch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Edit switch", "tags": [ "switch" ] } }, "/switch/{switch_id}/info": { "post": { "operationId": "switch_id_info_post", "parameters": [ { "description": "Switch unique identifier", "in": "path", "name": "switch_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchInfoEditPostParams" } } } }, "responses": { "200": { "description": "Switch port data have been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error saving switch port data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Edit switch port information (internal only)", "tags": [ "switch" ] } }, "/switch/{switch_id}/port": { "get": { "operationId": "switch_port_get", "parameters": [ { "description": "Switch unique identifier", "in": "path", "name": "switch_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Switch ports have been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchPortListResponse" } } } }, "default": { "description": "Error receiving a list of switch ports", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive switch ports information", "tags": [ "switch" ] } }, "/switch/{switch_id}/port/{port_id}": { "get": { "operationId": "switch_port_id_get", "parameters": [ { "description": "Switch unique identifier", "in": "path", "name": "switch_id", "required": true, "schema": { "type": "integer" } }, { "description": "Switch port unique identifier", "in": "path", "name": "port_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Switch port has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchPortGetResponse" } } } }, "default": { "description": "Switch port not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive information about switch port", "tags": [ "switch" ] }, "post": { "operationId": "switch_port_id_post", "parameters": [ { "description": "Switch unique identifier", "in": "path", "name": "switch_id", "required": true, "schema": { "type": "integer" } }, { "description": "Switch port unique identifier", "in": "path", "name": "port_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchPortEditPostParams" } } } }, "responses": { "200": { "description": "Switch port has been changed successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error saving switch port", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Edit switch port", "tags": [ "switch" ] } }, "/switch/{switch_id}/port/{port_id}/down": { "post": { "operationId": "switch_port_down_post", "parameters": [ { "description": "Switch unique identifier", "in": "path", "name": "switch_id", "required": true, "schema": { "type": "integer" } }, { "description": "Switch port ID", "in": "path", "name": "port_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Switch port has been powered off successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error powering off switch port", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Power off switch port", "tags": [ "switch" ] } }, "/switch/{switch_id}/port/{port_id}/up": { "post": { "operationId": "switch_port_up_post", "parameters": [ { "description": "Switch unique identifier", "in": "path", "name": "switch_id", "required": true, "schema": { "type": "integer" } }, { "description": "Switch port ID", "in": "path", "name": "port_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Switch port has been powered on successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error powering on switch port", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Power on switch port", "tags": [ "switch" ] } }, "/switch/{switch_id}/refresh": { "post": { "operationId": "switch_id_refresh", "parameters": [ { "description": "Switch unique identifier", "in": "path", "name": "switch_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Switch has been polled successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error polling switch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Switch poll", "tags": [ "switch" ] } }, "/switch/{switch_id}/status": { "post": { "operationId": "switch_id_status", "parameters": [ { "description": "Switch unique identifier", "in": "path", "name": "switch_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Switch has been polled successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error polling switch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Switch poll", "tags": [ "switch" ] } }, "/server/{server_id}/power_off": { "post": { "operationId": "server_id_power_off_post", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Server has been powered off successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error powering off server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Server power on", "tags": [ "server", "power" ] } }, "/server/{server_id}/power_on": { "post": { "operationId": "server_id_power_on_post", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Server has been powered on successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error powering on server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Server power on", "tags": [ "server", "power" ] } }, "/server/{server_id}/power_reset": { "post": { "operationId": "server_id_power_reset_post", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Server has been restarted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error restarting server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Server restart", "tags": [ "server", "power" ] } }, "/rack/{rack_id}/chassis": { "post": { "operationId": "rack_id_chassis_post", "parameters": [ { "description": "Location unique identifier", "in": "path", "name": "rack_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChassisCreatePostParams" } } } }, "responses": { "200": { "description": "Chassis has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error creating chassis", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Create chassis", "tags": [ "chassis" ] } }, "/chassis": { "get": { "operationId": "chassis_get", "responses": { "200": { "description": "Chassis list has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChassisListResponse" } } } }, "default": { "description": "Error receiving list of chassis", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive chassis list", "tags": [ "chassis" ] } }, "/chassis/{chassis_id}": { "get": { "operationId": "chassis_id_get", "parameters": [ { "description": "Chassis unique identifier", "in": "path", "name": "chassis_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Chassis has received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChassisGetResponse" } } } }, "default": { "description": "Chassis not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive chassis", "tags": [ "chassis" ] }, "post": { "operationId": "chassis_id_post", "parameters": [ { "description": "Chassis unique identifier", "in": "path", "name": "chassis_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChassisEditPostParams" } } } }, "responses": { "200": { "description": "Chassis has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error saving chassis", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Edit chassis", "tags": [ "chassis" ] } }, "/chassis/{chassis_id}/slot": { "get": { "operationId": "chassis_id_get_slots", "parameters": [ { "description": "Chassis unique identifier", "in": "path", "name": "chassis_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "List of chassis slots has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChassisGetSlotsResponse" } } } }, "default": { "description": "Error receiving a list of chassis slots", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive a list of chassis slots", "tags": [ "chassis" ] } }, "/cpu_socket": { "post": { "operationId": "cpu_socket_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CpuSocketCreatePostParams" } } } }, "responses": { "200": { "description": "CPU socket has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error creating CPU socket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Creating CPU socket", "tags": [ "cpu_socket" ] }, "get": { "operationId": "cpu_socket_get", "responses": { "200": { "description": "CPU sockets have been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CpuSocketListResponse" } } } }, "default": { "description": "Error receiving CPU sockets", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receiving all CPU sockets", "tags": [ "cpu_socket" ] } }, "/user": { "post": { "operationId": "user_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreatePostParams" } } } }, "responses": { "200": { "description": "User has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error creating user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Create user", "tags": [ "user" ] }, "get": { "operationId": "user_get", "responses": { "200": { "description": "Users list has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserListResponse" } } } }, "default": { "description": "Error receiving users list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive a list if all users", "tags": [ "user" ] } }, "/user/{user_id}": { "delete": { "operationId": "user_id_delete", "parameters": [ { "description": "User unique identifier", "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "User has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deleting user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Delete user", "tags": [ "user" ] } }, "/supported_pdu": { "get": { "operationId": "supported_pdu_get", "summary": "List of supported PDU", "tags": [ "pdu" ], "responses": { "200": { "description": "List of supported PDU has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedDevicesListResponse" } } } }, "default": { "description": "Error receiving a list of supported PDU", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/pdu": { "post": { "operationId": "pdu_post", "summary": "Create PDU", "tags": [ "pdu" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PduCreatePostParams" } } } }, "responses": { "200": { "description": "PDU has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error creating PDU", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "get": { "operationId": "pdu_get", "summary": "PDU list", "tags": [ "pdu" ], "responses": { "200": { "description": "PDU list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PduListResponse" } } } }, "default": { "description": "Error receiving PDU list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/pdu/{pdu_id}": { "get": { "operationId": "pdu_id_get", "summary": "PDU", "parameters": [ { "description": "PDU unique identifier", "in": "path", "name": "pdu_id", "required": true, "schema": { "type": "integer" } } ], "tags": [ "pdu" ], "responses": { "200": { "description": "PDU", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PduGetResponse" } } } }, "default": { "description": "Error receiving PDU", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "delete": { "operationId": "pdu_id_delete", "summary": "Delete PDU", "tags": [ "pdu" ], "parameters": [ { "description": "PDU unique identifier", "in": "path", "name": "pdu_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "PDU has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deleting PDU", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "post": { "operationId": "pdu_id_post", "summary": "Edit PDU", "tags": [ "pdu" ], "parameters": [ { "description": "PDU unique identifier", "in": "path", "name": "pdu_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PduEditPostParams" } } } }, "responses": { "200": { "description": "PDU has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error editing PDU", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/pdu/{pdu_id}/status": { "post": { "operationId": "pdu_id_status", "summary": "Poll PDU", "tags": [ "pdu" ], "parameters": [ { "description": "PDU unique identifier", "in": "path", "name": "pdu_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "PDU poll task has been registered", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error creating PDU poll task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/pdu/{pdu_id}/port": { "get": { "operationId": "pdu_port_get", "parameters": [ { "description": "PDU unique identifier", "in": "path", "name": "pdu_id", "required": true, "schema": { "type": "integer" } } ], "summary": "List of PDU ports", "tags": [ "pdu" ], "responses": { "200": { "description": "Ports list has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PduPortListResponse" } } } }, "default": { "description": "Error receiving list of ports", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/pdu/{pdu_id}/port/{port_id}": { "get": { "operationId": "pdu_port_get_id", "parameters": [ { "description": "PDU unique identifier", "in": "path", "name": "pdu_id", "required": true, "schema": { "type": "integer" } }, { "description": "PDU port unique identifier", "in": "path", "name": "port_id", "required": true, "schema": { "type": "integer" } } ], "summary": "Information about PDU port", "tags": [ "pdu" ], "responses": { "200": { "description": "Port information has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PduPortGetResponse" } } } }, "default": { "description": "Error receiving port information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "post": { "operationId": "pdu_port_id_post", "parameters": [ { "description": "PDU unique identifier", "in": "path", "name": "pdu_id", "required": true, "schema": { "type": "integer" } }, { "description": "PDU port unique identifier", "in": "path", "name": "port_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PduPortEditPostParams" } } } }, "responses": { "200": { "description": "PDU port information has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error saving PDU port information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Edit PDU port information", "tags": [ "pdu" ] } }, "/pdu/{pdu_id}/port/{port_id}/down": { "post": { "operationId": "pdu_port_down_post", "summary": "PDU port power off", "tags": [ "pdu" ], "parameters": [ { "description": "PDU unique identifier", "in": "path", "name": "pdu_id", "required": true, "schema": { "type": "integer" } }, { "description": "PDU port unique identifier", "in": "path", "name": "port_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Task for PDU port power off has been registered", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error creating a task for PDU port power off", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/pdu/{pdu_id}/port/{port_id}/up": { "post": { "operationId": "pdu_port_up_post", "summary": "PDU port power off", "tags": [ "pdu" ], "parameters": [ { "description": "PDU unique identifier", "in": "path", "name": "pdu_id", "required": true, "schema": { "type": "integer" } }, { "description": "PDU port unique identifier", "in": "path", "name": "port_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Task for PDU port power on has been registered", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error creating a task for PDU port power on", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/ippool": { "get": { "operationId": "ippool_get", "parameters": [ { "description": "The list of pools will be filtered by this location ID. If it is not specified, a full list will be displayed. Otherwise, the list will display the pools only from this location and public pools.\n", "in": "query", "name": "location", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "List of pools has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IppoolListResponse" } } } }, "default": { "description": "Error receiving a list of pools", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Error receiving a list of pools from IPmgr6 with the location field", "tags": [ "ipmgr" ] } }, "/ipnet": { "get": { "operationId": "ipnet_get", "parameters": [ { "description": "The list of networks will be filtered by this location ID. If it is not specified, a full list will be displayed. Otherwise, the list will display the networks only from this location and public networks.\n", "in": "query", "name": "location", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "List of networks has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpnetListResponse" } } } }, "default": { "description": "Error receiving a list of networks", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receiving a list of networks from IPmgr6 with the location field", "tags": [ "ipmgr" ] } }, "/server/{server_id}/owner": { "post": { "operationId": "server_id_owner_post", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerOwnerPostParams" } } } }, "responses": { "200": { "description": "Server owner has been changed successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error changing server owner", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Server owner change", "tags": [ "server" ] }, "delete": { "operationId": "server_id_owner_delete", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Server release", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error releasing server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Server release", "tags": [ "server" ] } }, "/location/{location_id}/rack": { "post": { "operationId": "location_id_rack_post", "parameters": [ { "description": "Location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RackCreatePostParams" } } } }, "responses": { "200": { "description": "Rack has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error saving rack", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Create rack", "tags": [ "rack" ] } }, "/rack": { "get": { "operationId": "rack_get", "responses": { "200": { "description": "Racks have been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RackListResponse" } } } }, "default": { "description": "Error receiving list of racks", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive all racks", "tags": [ "rack" ] } }, "/rack/{rack_id}": { "delete": { "operationId": "rack_id_delete", "parameters": [ { "description": "Rack unique identifier", "in": "path", "name": "rack_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Rack has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deleting rack", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Delete rack", "tags": [ "rack" ] }, "get": { "operationId": "rack_id_get", "parameters": [ { "description": "Rack unique identifier", "in": "path", "name": "rack_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Rack has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RackGetResponse" } } } }, "default": { "description": "Rack not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive rack", "tags": [ "rack" ] }, "post": { "operationId": "rack_id_post", "parameters": [ { "description": "Rack unique identifier", "in": "path", "name": "rack_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RackEditPostParams" } } } }, "responses": { "200": { "description": "Rack has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error saving rack", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Edit rack", "tags": [ "rack" ] } }, "/rack/{rack_id}/unit": { "get": { "operationId": "rack_id_get_units", "parameters": [ { "description": "Rack unique identifier", "in": "path", "name": "rack_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "List of rack units has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RackGetUnitsResponse" } } } }, "default": { "description": "Error receiving a list of rack units", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive a list of rack units", "tags": [ "rack" ] } }, "/location": { "get": { "operationId": "location_get", "responses": { "200": { "description": "Locations have been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationListResponse" } } } }, "default": { "description": "Error receiving list of locations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receiving all locations", "tags": [ "location" ] }, "post": { "operationId": "location_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationCreatePostParams" } } } }, "responses": { "200": { "description": "Location has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTasksIdSchema" } } } }, "default": { "description": "Error creating location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Creating location", "tags": [ "location" ] } }, "/location/{location_id}": { "delete": { "operationId": "location_id_delete", "parameters": [ { "description": "Location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Location has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deleting location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Deleting location", "tags": [ "location" ] }, "get": { "operationId": "location_id_get", "parameters": [ { "description": "Location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Location has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationGetResponse" } } } }, "default": { "description": "Location not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive location information", "tags": [ "location" ] }, "post": { "operationId": "location_id_post", "parameters": [ { "description": "Location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationEditPostParams" } } } }, "responses": { "200": { "description": "Location has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTasksIdSchema" } } } }, "default": { "description": "Error saving location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Edit location", "tags": [ "location" ] } }, "/location/{location_id}/setup": { "post": { "operationId": "location_id_setup_post", "parameters": [ { "description": "Location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationSetupPostParams" } } } }, "responses": { "200": { "description": "Location has been configured successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error configuring location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Configure location", "tags": [ "location" ] } }, "/location/{location_id}/message": { "post": { "operationId": "location_id_message_post", "parameters": [ { "description": "Location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationMessagePostParams" } } } }, "responses": { "200": { "description": "Message has been received successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error receiving message", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive messages about operation status", "tags": [ "location" ] } }, "/set_license": { "post": { "operationId": "set_license", "summary": "Saving the license", "tags": [ "license" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": {} } } } }, "responses": { "200": { "description": "License has been saved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } }, "default": { "description": "Error saving license", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/get_license": { "get": { "operationId": "get_license", "summary": "Receiving license", "tags": [ "license" ], "responses": { "200": { "description": "License has been received successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLicenseResponse" } } } }, "default": { "description": "Error receiving license", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/update_license": { "post": { "operationId": "update_license", "summary": "The license update", "tags": [ "license" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } }, "responses": { "200": { "description": "License has been updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } }, "default": { "description": "Error updating license", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/pdu_connection": { "post": { "operationId": "pdu_connection_post", "summary": "Server connection to PDU", "tags": [ "pdu_connection" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerToPduPostParams" } } } }, "responses": { "200": { "description": "Server has been successfully connected to PDU", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error connecting server to PDU", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/pdu_connection/{pdu_connection_id}": { "delete": { "operationId": "pdu_connection_id_delete", "summary": "Delete connection of server to PDU", "tags": [ "pdu_connection" ], "parameters": [ { "name": "pdu_connection_id", "description": "Unique identifier of server connection to PDU", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Server connection to PDU has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deleting server connection to PDU", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/location/{location_id}/vlan/{vlan_id}": { "delete": { "operationId": "location_id_vlan_id_delete", "parameters": [ { "description": "The location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } }, { "description": "The VLAN unique identifier", "in": "path", "name": "vlan_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The VLAN has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deleting the VLAN", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "The VLAN deletion", "tags": [ "vlan" ] }, "post": { "operationId": "location_id_vlan_id_post", "parameters": [ { "description": "The location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } }, { "description": "The VLAN unique identifier", "in": "path", "name": "vlan_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanEditPostParams" } } } }, "responses": { "200": { "description": "The VLAN has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error saving the VLAN", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "The VLAN edit", "tags": [ "vlan" ] }, "get": { "operationId": "location_id_vlan_id_get", "parameters": [ { "description": "The location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } }, { "description": "The VLAN unique identifier", "in": "path", "name": "vlan_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The VLAN has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanGetResponse" } } } }, "default": { "description": "The VLAN not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive information about VLAN", "tags": [ "vlan" ] } }, "/location/{location_id}/vlan": { "post": { "operationId": "vlan_post", "parameters": [ { "description": "The location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanCreatePostParams" } } } }, "responses": { "200": { "description": "The VLAN has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error saving vlan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Create vlan", "tags": [ "vlan" ] }, "get": { "operationId": "location_vlan_get", "parameters": [ { "description": "The location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The location vlans have been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationVlansListResponse" } } } }, "default": { "description": "Error receiving a list of location vlans", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive location vlans information", "tags": [ "vlan" ] } }, "/location/{location_id}/vlan/{vlan_id}/members": { "get": { "operationId": "location_id_vlan_id_members_get", "parameters": [ { "description": "The location unique identifier", "in": "path", "name": "location_id", "required": true, "schema": { "type": "integer" } }, { "description": "The VLAN unique identifier", "in": "path", "name": "vlan_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The VLAN members has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanMembersGetResponse" } } } }, "default": { "description": "The VLAN not found" } }, "summary": "The VLAN members list", "tags": [ "vlan" ] } }, "/server/{server_id}/ip": { "get": { "operationId": "server_id_ip_get", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "List of server IP addresses has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpListResponse" } } } }, "default": { "description": "Error receiving a list of server IP addresses", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive a list of server IP addresses", "tags": [ "ip" ] }, "post": { "operationId": "server_id_ip_post", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpCreatePostParams" } } } }, "responses": { "200": { "description": "IP has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error saving IP", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Create IP", "tags": [ "ip" ] } }, "/server/{server_id}/ip/{ip_id}": { "delete": { "operationId": "server_id_ip_id_delete", "parameters": [ { "description": "Ip address unique identifier", "in": "path", "name": "ip_id", "required": true, "schema": { "type": "integer" } }, { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "IP address has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error deleting IP address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Delete IP address", "tags": [ "ip" ] } }, "/ip": { "get": { "operationId": "ip_get", "responses": { "200": { "description": "List of IP addresses has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpListResponse" } } } }, "default": { "description": "Error receiving a list of IP addresses", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive a list of IP addresses", "tags": [ "ip" ] } }, "/ip/{ip_id}": { "delete": { "operationId": "ip_id_delete", "parameters": [ { "description": "IP address unique identifier", "in": "path", "name": "ip_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Ip address has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error deleting IP address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Delete IP address", "tags": [ "ip" ] }, "get": { "operationId": "ip_id_get", "parameters": [ { "description": "IP address unique identifier", "in": "path", "name": "ip_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "IP has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpGetResponse" } } } }, "default": { "description": "Error receiving IP address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive IP address", "tags": [ "ip" ] }, "post": { "operationId": "ip_id_post", "parameters": [ { "description": "IP address unique identifier", "in": "path", "name": "ip_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpEditPostParams" } } } }, "responses": { "200": { "description": "IP has been saved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error saving IP address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Edit IP", "tags": [ "ip" ] } }, "/server/{server_id}/switch_connection": { "get": { "operationId": "server_id_switch_connection_get", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "List of server connections to switches has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchConnectionListResponse" } } } }, "default": { "description": "Error receiving a list of server connections to switches", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive a list of server connections to switches", "tags": [ "server", "switch_connection" ] } }, "/switch_connection": { "post": { "operationId": "switch_connection_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerToSwitchPostParams" } } } }, "responses": { "200": { "description": "Server has been connected to switch successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error connecting server to switch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Connect server to switch", "tags": [ "switch_connection" ] } }, "/switch_connection/{switch_connection_id}": { "get": { "tags": [ "switch_connection" ], "summary": "Receive information about server connection to switch", "operationId": "switch_connection_id_get", "parameters": [ { "name": "switch_connection_id", "in": "path", "required": true, "description": "Unique identifier of server connection to switch", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Information about server connection to switch has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchConnectionGetResponse" } } } }, "default": { "description": "Error receiving information about server connection to switch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "delete": { "operationId": "switch_connection_id_delete", "parameters": [ { "name": "switch_connection_id", "description": "Unique identifier of server connection to switch", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Server connection to switch has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deleting server connection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Delete server connections to switch", "tags": [ "switch_connection" ] }, "post": { "operationId": "switch_connection_id_post", "parameters": [ { "name": "switch_connection_id", "description": "Unique identifier of server connection to switch", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Server connection to switch has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessSchema" } } } }, "default": { "description": "Error editing server connection to switch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Edit server connection to switch", "tags": [ "switch_connection" ] } }, "/server": { "get": { "operationId": "server_get", "responses": { "200": { "description": "Servers have been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerListResponse" } } } }, "default": { "description": "Error receiving servers list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive information about servers", "tags": [ "server" ] }, "post": { "operationId": "server_post", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ServerCreatePostParams" }, { "$ref": "#/components/schemas/BladeServerCreatePostParams" } ] } } } }, "responses": { "200": { "description": "Server has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error saving server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Create server", "tags": [ "server" ] } }, "/server/{server_id}": { "delete": { "operationId": "server_id_delete", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Server has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deleting server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Delete server", "tags": [ "server" ] }, "get": { "operationId": "server_id_get", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Server has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerGetResponse" } } } }, "default": { "description": "Server not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive server information", "tags": [ "server" ] }, "post": { "operationId": "server_id_post", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerEditPostParams" } } } }, "responses": { "200": { "description": "Server has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error saving server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Edit server", "tags": [ "server" ] } }, "/server/{server_id}/last_operation": { "get": { "operationId": "server_id_last_operation_get", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Operation has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationGetResponse" } } } }, "default": { "description": "Operation not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive information about operation", "tags": [ "server" ] } }, "/server/{server_id}/suspend": { "post": { "operationId": "server_id_suspend", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Switch ports connected to server have been powered off successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error powering off switch ports connected to server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Power off switch ports connected to server.", "tags": [ "server" ] } }, "/server/{server_id}/resume": { "post": { "operationId": "server_id_resume", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "Switch ports connected to server have been powered on successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error powering on switch ports connected to server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Power on switch ports connected to server.", "tags": [ "server" ] } }, "/server/configuration": { "get": { "operationId": "servers_configuration_get", "responses": { "200": { "description": "List of servers configurations has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServersConfigurationGetResponse" } } } }, "default": { "description": "Cannot receive a list of servers configurations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive a list of all unique servers configurations and number of available servers corresponding to these configurations. Integration with billing system is required\n", "tags": [ "server" ] } }, "/server/free": { "get": { "operationId": "server_free_get", "responses": { "200": { "description": "Free servers have been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerListResponse" } } } }, "default": { "description": "Failed to receive free servers list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive information about servers that are able to be dedicated to client. These servers meet the following conditions: - server has no owner - server diagnostics completed and its configuration has been received - server last operation completed successfully or canceled\n", "tags": [ "server" ] } }, "/ipmi": { "get": { "operationId": "ipmi_get", "responses": { "200": { "description": "List of IPMI connections has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpmiListResponse" } } } }, "default": { "description": "Error receiving a list of IPMI connections", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receiving list of IPMI connections", "tags": [ "ipmi" ] } }, "/ipmi/{ipmi_id}": { "delete": { "operationId": "ipmi_id_delete", "parameters": [ { "description": "IPMI connection unique identifier", "in": "path", "name": "ipmi_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "IPMI connection has been deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deleting IPMI connections", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Deleting IPMI connections", "tags": [ "ipmi" ] }, "get": { "operationId": "ipmi_id_get", "parameters": [ { "description": "IPMI unique identifier", "in": "path", "name": "ipmi_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Information about IPMI connection has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpmiGetResponse" } } } }, "default": { "description": "IPMI connection not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Getting information about IPMI connection", "tags": [ "ipmi" ] }, "post": { "operationId": "ipmi_id_post", "parameters": [ { "description": "IPMI connection unique identifier", "in": "path", "name": "ipmi_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpmiEditPostParams" } } } }, "responses": { "200": { "description": "IPMI connection has been edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error saving IPMI connection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Editing IPMI connection", "tags": [ "ipmi" ] } }, "/ipmi/{ipmi_id}/status": { "post": { "operationId": "ipmi_id_status_post", "parameters": [ { "description": "IPMI connection unique identifier", "in": "path", "name": "ipmi_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/EmptyRequest" }, "responses": { "200": { "description": "IPMI status has been received successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error receiving IPMI status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receiving IPMI status", "tags": [ "ipmi" ] } }, "/server/{server_id}/ipmi": { "post": { "operationId": "server_id_ipmi_post", "parameters": [ { "description": "Server unique identifier", "in": "path", "name": "server_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpmiCreatePostParams" } } } }, "responses": { "200": { "description": "IPMI has been created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessTaskSchema" } } } }, "default": { "description": "Error saving IPMI", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Creating IPMI", "tags": [ "ipmi" ] } } } }
Thank you for your feedback!
Was the article useful?
Tell us why not:

it does not match the title

it was hard to understand

I didn't find the answer

recommendations from the article did not help

other

Tell us what you didn't like in the article: