swagger.json

{"swagger": "2.0", "basePath": "/api/v2", "paths": {"/bandwidth/device/{deviceId}": {"parameters": [{"required": true, "in": "path", "description": "ID of Device to View", "name": "deviceId", "type": "integer"}, {"default": "day", "required": true, "type": "string", "enum": ["day", "week", "month", "custom"], "in": "query", "description": "Preconfigured Time Periods for Graph Data", "name": "period"}, {"default": "eth0", "required": true, "type": "string", "enum": ["eth0", "eth1", "public", "private", "all"], "in": "query", "description": "Network Interface to use for Graph Data", "name": "interface"}, {"type": "boolean", "default": false, "in": "query", "description": "Include Historical Interface Data for Device for Resellers", "name": "historical"}, {"default": 300, "type": "integer", "required": true, "in": "query", "description": "Interval of Graph in Seconds", "name": "step"}, {"type": "integer", "default": 0, "in": "query", "description": "Start Time of Custom Time Period. (Unix Epoch Time)", "name": "start"}, {"type": "integer", "default": 1602779506, "in": "query", "description": "End Time of Custom Time Period (Unix Epoch Time)", "name": "end"}], "post": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Bandwidth"}}}}, "summary": "Returns RRDTool Xport based bandwidth data in JSON format", "operationId": "post_device_id_bandwidth_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Bandwidth"]}}, "/bandwidth/device/{deviceId}/image": {"parameters": [{"required": true, "in": "path", "description": "ID of Device to View", "name": "deviceId", "type": "integer"}, {"default": "day", "required": true, "type": "string", "enum": ["day", "week", "month", "custom"], "in": "query", "description": "Preconfigured Time Periods for Graph Data", "name": "period"}, {"default": "eth0", "required": true, "type": "string", "enum": ["eth0", "eth1", "public", "private", "all"], "in": "query", "description": "Network Interface to use for Graph Data", "name": "interface"}, {"type": "integer", "default": 0, "in": "query", "description": "Start Time of Custom Time Period. (Unix Epoch Time)", "name": "start"}, {"type": "integer", "default": 1602779506, "in": "query", "description": "End Time of Custom Time Period (Unix Epoch Time)", "name": "end"}], "post": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BandwidthImage"}}}}, "summary": "Returns RRDTool Graph based bandwidth in PNG format", "operationId": "post_device_id_bandwidth_image_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Bandwidth"]}}, "/bandwidth/service/{serviceId}": {"parameters": [{"required": true, "in": "path", "description": "ID of Service to View", "name": "serviceId", "type": "integer"}, {"default": "day", "required": true, "type": "string", "enum": ["day", "week", "month", "custom"], "in": "query", "description": "Preconfigured Time Periods for Graph Data", "name": "period"}, {"default": "eth0", "required": true, "type": "string", "enum": ["eth0", "eth1", "public", "private", "all"], "in": "query", "description": "Network Interface to use for Graph Data", "name": "interface"}, {"default": 300, "type": "integer", "required": true, "in": "query", "description": "Interval of Graph in Seconds", "name": "step"}, {"type": "integer", "default": 0, "in": "query", "description": "Start Time of Custom Time Period. (Unix Epoch Time)", "name": "start"}, {"type": "integer", "default": 1602779506, "in": "query", "description": "End Time of Custom Time Period (Unix Epoch Time)", "name": "end"}], "post": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Bandwidth"}}}}, "summary": "Returns RRDTool Xport based bandwidth data in JSON format", "operationId": "post_service_id_bandwidth_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Bandwidth"]}}, "/bandwidth/service/{serviceId}/image": {"parameters": [{"required": true, "in": "path", "description": "ID of Service to View", "name": "serviceId", "type": "integer"}, {"default": "day", "required": true, "type": "string", "enum": ["day", "week", "month", "custom"], "in": "query", "description": "Preconfigured Time Periods for Graph Data", "name": "period"}, {"default": "eth0", "required": true, "type": "string", "enum": ["eth0", "eth1", "public", "private", "all"], "in": "query", "description": "Network Interface to use for Graph Data", "name": "interface"}, {"type": "integer", "default": 0, "in": "query", "description": "Start Time of Custom Time Period. (Unix Epoch Time)", "name": "start"}, {"type": "integer", "default": 1602779506, "in": "query", "description": "End Time of Custom Time Period (Unix Epoch Time)", "name": "end"}], "post": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BandwidthImage"}}}}, "summary": "Returns RRDTool Graph based bandwidth in PNG format", "operationId": "post_service_id_bandwidth_image_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Bandwidth"]}}, "/bare-metal-devices/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BareMetalDevice"}}}}, "summary": "Return a list with all servers as bare metal", "operationId": "get_bare_metal_device_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Bare Metal Devices"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/BareMetalDevice"}}}, "summary": "Deploy a new bare metal server", "operationId": "post_bare_metal_device_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BareMetalDeviceCreate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Bare Metal Devices"]}}, "/bare-metal-devices/{deviceId}": {"parameters": [{"in": "query", "description": "Id of the deployment to interact with", "name": "deploymentId", "type": "string"}, {"name": "deviceId", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/BareMetalDevice"}}}, "summary": "Return bare metal device", "operationId": "get_bare_metal_device_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Bare Metal Devices"]}, "delete": {"responses": {"201": {"description": "Cancellation Started."}, "204": {"description": "Device Deleted"}, "401": {"description": "Not Allowed"}, "404": {"description": "Device Not Found"}}, "summary": "Cancel the specified bare metal device", "operationId": "delete_bare_metal_device_id_resource", "tags": ["Bare Metal Devices"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/BareMetalDevice"}}}, "summary": "Update a bare metal device", "operationId": "put_bare_metal_device_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BareMetalDeviceUpdate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Bare Metal Devices"]}}, "/billing-info/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BillingInfo"}}}}, "summary": "Return a list with all Billing Info", "operationId": "get_billing_info_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["BillingInfo"]}}, "/cancellation/cancellation": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Cancellation"}}}}, "summary": "Returns the services cancellations of a client", "operationId": "get_cancellation_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Cancellation"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Cancellation"}}}, "summary": "Creates Cancellation for a device/service", "description": "reason options are:\n    'My current service is being upgraded',\n    'Hardware/software/network or power issues',\n    'I think I have found a better deal',\n    'I have experienced tech support problems',\n    'I am consolidating my Hivelocity accounts',\n    'I am a reseller and my customer cancelled',\n    'I am moving to a different technology solution: Public Cloud',\n    'I am moving to a different technology solution: Managed Hosting Company',\n    'A product difference (Example: AWS)',\n    ''", "operationId": "post_cancellation_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CancellationCreate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Cancellation"]}}, "/cancellation/cancellation/{cancellationId}": {"parameters": [{"name": "cancellationId", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Cancellation"}}}, "summary": "Return any cancellation by ID", "operationId": "get_cancellation_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Cancellation"]}}, "/cancellation/device/{deviceId}": {"parameters": [{"name": "deviceId", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Cancellation"}}}, "summary": "Return the Cancellation found for a Device", "operationId": "get_cancellation_device_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Cancellation"]}}, "/cancellation/service/{serviceId}": {"parameters": [{"name": "serviceId", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Cancellation"}}}, "summary": "Return the Cancellation found for a Service", "operationId": "get_cancellation_service_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Cancellation"]}}, "/contact/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Contact-dump"}}}}, "summary": "Return a list with all Contacts", "operationId": "get_contact_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Contact"]}, "post": {"responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Contact-dump"}}}, "summary": "Create a new Contact", "operationId": "post_contact_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ContactCreate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Contact"]}}, "/contact/password": {"put": {"responses": {"200": {"description": "Success"}}, "summary": "Recieve a token and password, verify the user and reset your password", "operationId": "put_password_reset", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PasswordResponse"}}], "tags": ["Contact"]}, "post": {"responses": {"200": {"description": "Success"}}, "summary": "Recieve a request to reset password, and send a link by email with token", "operationId": "post_password_reset", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PasswordRequest"}}], "tags": ["Contact"]}}, "/contact/{contactId}": {"parameters": [{"in": "path", "description": "ID of Contact to View / Update", "name": "contactId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Contact-dump"}}}, "summary": "Return details of a specific Contact", "operationId": "get_contact_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Contact"]}, "delete": {"responses": {"404": {"description": "Contact not found."}, "204": {"description": "Contact successfully deleted."}}, "summary": "Delete a Contact", "operationId": "delete_contact_id_resource", "tags": ["Contact"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Contact-dump"}}}, "summary": "Edit a Contact", "operationId": "put_contact_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ContactUpdate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Contact"]}}, "/contact/{contactId}/password": {"parameters": [{"in": "path", "description": "\"ID of Contact to change password\"", "name": "contactId", "required": true, "type": "integer"}], "put": {"responses": {"400": {"description": "Invalid password for authentication."}, "200": {"description": "Password was changed."}}, "summary": "Change password for a Contact", "operationId": "put_password_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/Password"}}], "tags": ["Contact"]}}, "/credit/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Credit"}}}}, "summary": "Return a list with all Credits", "operationId": "get_credit_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Credit"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Credit"}}}, "summary": "Receive billing method id and amount and return the created Credit", "operationId": "post_credit_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateCredit"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Credit"]}}, "/credit/total": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TotalActiveCredit"}}}, "summary": "Return the client's total active credit amount", "operationId": "get_total_active_credit_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Credit"]}}, "/deploy/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Deployment"}}}}, "summary": "Return a list with all client deployments", "operationId": "get_deployment_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Deployment"]}, "post": {"responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Deployment"}}}, "summary": "Start a new deployment", "operationId": "post_deployment_resource", "parameters": [{"name": "deploymentName", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Deployment"]}}, "/deploy/{deploymentId}": {"parameters": [{"in": "path", "description": "Id of the deployment to interact with", "name": "deploymentId", "required": true, "type": "integer"}], "put": {"responses": {"200": {"description": "Server configuration added to Deployment", "schema": {"$ref": "#/definitions/Deployment"}}, "400": {"description": "Your configuration have incompatible or unavailable options"}, "401": {"description": "Access to this Deployment not Allowed"}, "404": {"description": "Deployment Not Found"}}, "summary": "Receive product, quantity and options to be added on the deployment", "operationId": "put_deployment_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DeploymentCustomization"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Deployment"]}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Deployment"}}}, "summary": "Return a dictionary with deployment information", "operationId": "get_deployment_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Deployment"]}, "delete": {"responses": {"204": {"description": "Deployment Deleted"}, "401": {"description": "Access to this Deployment not Allowed"}, "404": {"description": "Deployment Not Found"}}, "summary": "Delete the specified deployment", "operationId": "delete_deployment_id_resource", "tags": ["Deployment"]}, "post": {"responses": {"201": {"description": "Deployment Started"}, "401": {"description": "Access to Deployment not Allowed"}, "404": {"description": "Deployment Not Found"}}, "summary": "Input a billing info id to process and finish a deployment", "operationId": "post_deployment_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DeploymentStart"}}], "tags": ["Deployment"]}}, "/device/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Device"}}}}, "summary": "Returns Active Devices and basic MetaData", "operationId": "get_device_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/ipmi/thresholds": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DevicesIPMIThresholds"}}}, "summary": "Updates IPMI thresholds for device list", "operationId": "put_ipmi_devices_thresholds_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateDevicesIPMIThresholds"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/tags": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DeviceTag"}}}, "summary": "Get all device tags for current client", "operationId": "get_client_device_tag_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/tags-order": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DeviceTag"}}}, "summary": "Get device tags order for current user", "operationId": "get_client_device_tag_order_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DeviceTag"}}}, "summary": "Update device tags order for current user", "operationId": "put_client_device_tag_order_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DeviceTag"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/tags-order/all": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DeviceTag"}}}, "summary": "Get all device tags order", "operationId": "get_all_device_tag_order_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/{deviceId}": {"parameters": [{"in": "path", "description": "ID of Device to View / Update", "name": "deviceId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Device"}}}, "summary": "Returns detailed information for a Single Device", "operationId": "get_device_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Device"}}}, "summary": "Updates Device MetaData for a Single Device", "operationId": "put_device_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DeviceUpdate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/{deviceId}/events": {"parameters": [{"name": "deviceId", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/DeviceEvent"}}}}, "summary": "Returns all Events found for a single device", "operationId": "get_device_id_event_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/{deviceId}/initial-password": {"parameters": [{"required": true, "in": "path", "description": "ID of Device to retrieve initial password", "name": "deviceId", "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DevicePassword"}}}, "summary": "Returns initial password for the device", "operationId": "get_initial_password_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/{deviceId}/interfaces": {"parameters": [{"in": "path", "description": "ID of Device to view Network Interfaces.", "name": "deviceId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/DeviceInterface"}}}}, "summary": "Returns a list of all Network Interfaces bound to a Device", "operationId": "get_network_interface_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/{deviceId}/ipmi": {"parameters": [{"required": true, "in": "path", "description": "ID of Device to retrieve IPMI info.", "name": "deviceId", "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DeviceIPMIInfo"}}}, "summary": "Returns IPMI info data", "operationId": "get_ipmi_info_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/{deviceId}/ipmi/thresholds": {"parameters": [{"required": true, "in": "path", "description": "ID of Device to View", "name": "deviceId", "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DeviceIPMIThresholds"}}}, "summary": "Returns IPMI thresholds data", "operationId": "get_ipmi_thresholds_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DeviceIPMIThresholds"}}}, "summary": "Updates IPMI thresholds data", "operationId": "put_ipmi_thresholds_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DeviceIPMIThresholds"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/{deviceId}/ipmi/valid-login": {"parameters": [{"required": true, "in": "path", "description": "ID of Device to check IPMI credentials", "name": "deviceId", "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/IPMIValidLogin"}}}, "summary": "Returns if device have valid credentials for IPMI login", "operationId": "get_ipmi_valid_login_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/{deviceId}/ipmi/whitelist/": {"parameters": [{"in": "path", "description": "ID of the Device to put IP in Whitelist", "name": "deviceId", "required": true, "type": "integer"}], "post": {"responses": {"400": {"description": "The request has problems. Revise it and try again."}, "202": {"description": "The request was accepted."}}, "summary": "Include the custip (custom IP) on IPMI WhiteList", "operationId": "post_device_ipmi_whitelist_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DeviceIPMIWhitelistIP"}}], "tags": ["Device"]}}, "/device/{deviceId}/ipmi/whitelist/{actionId}": {"parameters": [{"in": "path", "description": "ID of the Device to add IP in Whitelist", "name": "deviceId", "required": true, "type": "integer"}, {"name": "actionId", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Action ID wasn't found."}, "200": {"description": "The state of action! The possible values are Running or Succeeded."}}, "summary": "Retrieve the state of the action to add the IP into Whitelist", "operationId": "get_device_ipmi_whitelist_action_resource", "tags": ["Device"]}}, "/device/{deviceId}/ipmi/whitelist/{actionId}/public-ip": {"parameters": [{"in": "path", "description": "ID of the action to add IP in Whitelist", "name": "actionId", "required": true, "type": "string"}, {"in": "path", "description": "ID of the Device to add IP in Whitelist", "name": "deviceId", "required": true, "type": "integer"}], "get": {"responses": {"404": {"description": "Action ID wasn't found."}, "200": {"description": "The Whitelist Public IP."}}, "summary": "Retrieve the Public IP using the Device ID and the Action ID that was used to add it to Whitelist", "operationId": "get_device_ipmi_whitelist_public_ip", "tags": ["Device"]}}, "/device/{deviceId}/power": {"parameters": [{"in": "path", "description": "ID of Device to View / Update", "name": "deviceId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DevicePower"}}}, "summary": "Get device's current power status", "operationId": "get_power_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}, "post": {"responses": {"202": {"description": "Success", "schema": {"$ref": "#/definitions/DevicePower"}}}, "summary": "Apply action to device power", "operationId": "post_power_resource", "parameters": [{"name": "action", "in": "query", "type": "string", "pattern": "boot|reboot|shutdown", "required": true, "description": "Must be one of boot|reboot|shutdown"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/device/{deviceId}/tags": {"parameters": [{"in": "path", "description": "ID of Device to View / Update", "name": "deviceId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DeviceTag"}}}, "summary": "Get device tags", "operationId": "get_device_tag_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DeviceTag"}}}, "summary": "Update device tags", "operationId": "put_device_tag_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DeviceTag"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Device"]}}, "/inventory/product": {"parameters": [{"default": "MAIN", "type": "string", "enum": ["MAIN", "MASSIVESTORAGE", "GPU", "OUTLET", "LANDING"], "in": "query", "description": "Filter products by location", "name": "location"}, {"default": "facility", "in": "query", "description": "Get results grouped by 'city', 'facility', or 'flat'", "name": "group_by", "type": "string"}], "get": {"responses": {"200": {"description": "Product data was found", "schema": {"$ref": "#/definitions/Inventory"}}}, "summary": "Return structured sps stock data, grouped by city or facility code for all products", "operationId": "get_stock_resource", "tags": ["Inventory"]}}, "/inventory/product/{productId}": {"parameters": [{"in": "path", "description": "Product database ID", "name": "productId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Stock"}}}, "summary": "Return a structured sps stock data, grouped by city or facility code for a single product", "operationId": "get_stock_by_product_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Inventory"]}}, "/invoice/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Invoice"}}}}, "summary": "Return serialized data on all invoices", "operationId": "get_invoice_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Invoice"]}}, "/invoice/{invoiceId}": {"parameters": [{"in": "path", "description": "Invoice database ID", "name": "invoiceId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Invoice"}}}, "summary": "Return serialized data on a single invoice", "operationId": "get_invoice_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Invoice"]}}, "/invoice/{invoiceId}/details": {"parameters": [{"in": "path", "description": "Invoice database ID", "name": "invoiceId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/InvoiceDetails"}}}, "summary": "Return detailed information for an invoice", "description": "Same data as the PDF file but serialized", "operationId": "get_invoice_id_details", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Invoice"]}}, "/invoice/{invoiceId}/pdf-download": {"parameters": [{"in": "path", "description": "Invoice database ID", "name": "invoiceId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/InvoicePDF"}}}, "summary": "Return an Invoice PDF file in Base64 Encoded Format", "operationId": "get_invoice_pdf_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Invoice"]}}, "/order/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Order-dump"}}}}, "summary": "Return a list with all Orders", "operationId": "get_order_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Order"]}}, "/order/{orderId}": {"parameters": [{"in": "path", "description": "\"ID of Order to View\"", "name": "orderId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Order-dump"}}}, "summary": "Return details of a specific Order", "operationId": "get_order_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Order"]}}, "/permission/": {"get": {"responses": {"200": {"description": "Success"}}, "summary": "Endpoint to get All Permissions", "operationId": "get_permission_all_resource", "tags": ["Permission"]}}, "/permission/contact": {"post": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/PermissionReturn"}}}}, "summary": "Endpoint to assign a new Permission to a Contact", "operationId": "post_permission_assign_contact_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/Permission"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Permission"]}}, "/permission/contact/{contactId}": {"parameters": [{"name": "contactId", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success"}}, "summary": "Endpoint to get Contact Permissions", "operationId": "get_permission_contact_resource", "tags": ["Permission"]}}, "/permission/user": {"get": {"responses": {"200": {"description": "Success"}}, "summary": "Endpoint to get User Permissions", "operationId": "get_permission_user_resource", "tags": ["Permission"]}}, "/product/list": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProductInfo"}}}}, "summary": "Return structured sps stock data in a list", "operationId": "get_product_list_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Product"]}}, "/product/match": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ProductMatchResult"}}}, "summary": "Return a list of Products matching the provided lshw output of a server", "operationId": "post_product_match_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ProductMatch"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Product"]}}, "/product/{productId}/operating-systems": {"parameters": [{"in": "path", "description": "ID of the Product", "name": "productId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Option"}}}}, "summary": "Return List of operating systems found for a Product", "operationId": "get_product_operating_systems_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Product"]}}, "/product/{productId}/options": {"parameters": [{"default": "upgrade", "in": "query", "description": "Get results grouped by 'upgrade' or without grouping.", "name": "groupBy", "type": "string"}, {"in": "path", "description": "ID of the Product", "name": "productId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Product data was found", "schema": {"$ref": "#/definitions/Options"}}}, "summary": "Return List of Options found for a Product", "operationId": "get_product_option_resource", "tags": ["Product"]}}, "/profile/": {"parameters": [{"in": "query", "description": "\"ID of Contact to manage Profile\"", "name": "contactId", "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Profile"}}}, "summary": "Get Profile of current user or a contact with id", "description": "The id is optional and if it is necessary must be sent as URL param.", "operationId": "get_profile_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Profile"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Profile"}}}, "summary": "Update Profile of current user or a contact with id", "description": "The id is optional and if it is necessary must be sent as URL param.", "operationId": "put_profile_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ProfileUpdate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Profile"]}}, "/profile/basic": {"parameters": [{"in": "query", "description": "\"ID of Contact to manage Basic Profile\"", "name": "contactId", "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/BasicProfile"}}}, "summary": "Get Basic Profile of current user or a contact with id", "description": "The id is optional and if it is necessary must be sent as URL param.", "operationId": "get_basic_profile_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Profile"]}}, "/service/": {"parameters": [{"default": "all", "required": true, "type": "string", "enum": ["all", "active", "deactivated", "pending", "suspended", "cancelled"], "in": "query", "description": "The current status of the service", "name": "status"}], "get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Service-dump"}}}}, "summary": "Return a list of all account services", "operationId": "get_service_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Service"]}}, "/service/{serviceId}": {"parameters": [{"name": "serviceId", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Service-dump"}}}, "summary": "Return a dictionary with data from a specific account service", "operationId": "get_service_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Service"]}}, "/ssh_key/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/SshKeyResponse"}}}}, "summary": "Gets all public ssh key", "operationId": "get_ssh_key_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["SshKey"]}, "post": {"responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/SshKeyResponse"}}}, "summary": "Adds public ssh key", "operationId": "post_ssh_key_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SshKey"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["SshKey"]}}, "/ssh_key/{clientId}": {"parameters": [{"name": "clientId", "in": "path", "required": true, "type": "integer"}]}, "/ssh_key/{sshKeyId}": {"parameters": [{"name": "sshKeyId", "in": "path", "required": true, "type": "integer"}], "delete": {"responses": {"403": {"description": "Current user is not the owner."}, "404": {"description": "Public ssh key not found."}, "200": {"description": "Public ssh key successfully removed."}}, "summary": "Removes public ssh key", "operationId": "delete_ssh_key_id_resource", "tags": ["SshKey"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/SshKeyResponse"}}}, "summary": "Updates public ssh key", "operationId": "put_ssh_key_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SshKeyUpdate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["SshKey"]}}, "/tickets/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Ticket"}}}}, "summary": "Returns a list with all Tickets", "operationId": "get_ticket_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Ticket"]}, "post": {"responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Ticket"}}}, "summary": "Creates a new ticket", "operationId": "post_ticket_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TicketCreate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Ticket"]}}, "/tickets/search": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TicketSeachResult"}}}, "summary": "Return results of ticket search", "operationId": "get_ticket_search_resource", "parameters": [{"default": 10, "type": "integer", "in": "query", "description": "Number of items per page.", "name": "perPage"}, {"default": 1, "type": "integer", "in": "query", "description": "The page number of search.", "name": "page"}, {"type": "string", "in": "query", "description": "Content search.", "name": "q"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Ticket"]}}, "/tickets/{ticketId}": {"parameters": [{"in": "path", "description": "ticket database ID", "name": "ticketId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Ticket"}}}, "summary": "Returns details of a specific ticket", "operationId": "get_ticket_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Ticket"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Ticket"}}}, "summary": "Updates a specific ticket", "operationId": "put_ticket_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TicketPut"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Ticket"]}}, "/tickets/{ticketId}/reply": {"parameters": [{"in": "path", "description": "ticket database ID", "name": "ticketId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/TicketPost"}}}}, "summary": "Returns a reply for a specific ticket", "operationId": "get_ticket_reply_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Ticket"]}, "post": {"responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/TicketPost"}}}, "summary": "Creates reply for a specific Ticket", "operationId": "post_ticket_reply_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TicketCreateReply"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Ticket"]}}, "/token/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/PublicApiToken-dump"}}}}, "summary": "Returns a list of Public API Tokens for the current user", "operationId": "get_token_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Token"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PublicApiToken-dump"}}}, "summary": "Create a new Public API Token for the current user", "operationId": "post_token_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PublicApiToken-load"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Token"]}}, "/token/{token}": {"parameters": [{"required": true, "in": "path", "description": "Public API Token", "name": "token", "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PublicApiToken-dump"}}}, "summary": "Returns Public API Token", "operationId": "get_token_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Token"]}, "delete": {"responses": {"400": {"description": "Unable to remove the Public API Token."}, "201": {"description": "Public API Token successfully removed."}}, "summary": "Deletes the Public API Token", "operationId": "delete_token_id_resource", "tags": ["Token"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PublicApiToken-dump"}}}, "summary": "Updates the Public API Token", "operationId": "put_token_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PublicApiToken-load"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Token"]}}, "/webhooks/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/Webhook"}}}}, "summary": "Returns your active Webhooks", "operationId": "get_webhook_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Webhook"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Webhook"}}}, "summary": "Create a new Webhook for a Webhook Event", "operationId": "post_webhook_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WebhookCreate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Webhook"]}}, "/webhooks/events": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/WebhookEvent"}}}}, "summary": "Returns all available Webhook Events", "operationId": "get_webhook_event_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Webhook"]}}, "/webhooks/trigger": {"parameters": [{"in": "query", "description": "The name of the webhook to trigger.", "name": "webhookName", "type": "string"}], "post": {"responses": {"202": {"description": "Accepted."}}, "summary": "Queues a webhook for the event script action that was triggered", "operationId": "post_event_script_action_trigger_resource", "tags": ["Webhook"]}}, "/webhooks/{webhookId}": {"parameters": [{"in": "path", "description": "ID of Webhook to View / Update", "name": "webhookId", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Webhook"}}}, "summary": "Returns detailed information for a Single Webhook", "operationId": "get_webhook_id_resource", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Webhook"]}, "delete": {"responses": {"204": {"description": "Webhook was deleted."}}, "summary": "Deletes a single webhook", "operationId": "delete_webhook_id_resource", "tags": ["Webhook"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Webhook"}}}, "summary": "Updates a Single Webhook", "operationId": "put_webhook_id_resource", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WebhookUpdate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["Webhook"]}}}, "info": {"title": "Hivelocity API", "version": "2.0", "description": "Interact with Hivelocity"}, "produces": ["application/json"], "consumes": ["application/json"], "securityDefinitions": {"apiKey": {"type": "apiKey", "in": "header", "name": "X-API-KEY"}}, "security": [{"apiKey": []}], "tags": [{"name": "Bandwidth", "description": "Request RRDTool Based Bandwidth Data from a Resource."}, {"name": "Bare Metal Devices", "description": "Endpoints to handle provisioning bare metal.  See all devices with the /devices endpoint."}, {"name": "BillingInfo", "description": "Endpoints to manage Billing Info"}, {"name": "Cancellation", "description": "Cancellation information"}, {"name": "Contact", "description": "Endpoints to manager Contacts"}, {"name": "Credit", "description": "Endpoints to manage Credit"}, {"name": "Device", "description": "Access to your Bare-Metal or Virtual Devices"}, {"name": "Inventory", "description": "Products Inventory Data"}, {"name": "Invoice", "description": "Invoice information and PDF download"}, {"name": "Order", "description": "Get Order and its details"}, {"name": "Permission", "description": "Endpoints to manage Permissions"}, {"name": "Product", "description": "Endpoints to manage Products"}, {"name": "Profile", "description": "Endpoints to manage Profiles"}, {"name": "Deployment", "description": "Endpoints to handle your servers provisioning"}, {"name": "Service", "description": "Service information"}, {"name": "SshKey", "description": "Endpoints to manage SSH key."}, {"name": "Ticket", "description": "Ticket information"}, {"name": "Token", "description": "Endpoints to manage Public API Token"}, {"name": "Webhook", "description": "Access and modify your Hivelocity webhooks."}], "definitions": {"Bandwidth": {"properties": {"metadata": {"type": "object"}, "bandwidthData": {"type": "array", "items": {"type": "array", "items": {"type": "number"}}}, "interface": {"type": "string"}, "switchId": {"type": "string"}}, "type": "object"}, "BandwidthImage": {"properties": {"graphImage": {"type": "string"}, "interface": {"type": "string"}, "switchId": {"type": "string"}}, "type": "object"}, "BareMetalDeviceCreate": {"required": ["hostname", "locationName", "osName", "productId"], "properties": {"deviceId": {"type": "integer"}, "primaryIp": {"type": "string"}, "powerStatus": {"type": "string"}, "serviceId": {"type": "integer"}, "productName": {"type": "string"}, "osName": {"type": "string"}, "orderId": {"type": "integer"}, "tags": {"type": "array", "items": {"type": "string"}}, "vlanId": {"type": "integer"}, "productId": {"type": "integer"}, "hostname": {"type": "string"}, "locationName": {"type": "string"}}, "type": "object"}, "BareMetalDevice": {"properties": {"deviceId": {"type": "integer"}, "primaryIp": {"type": "string"}, "powerStatus": {"type": "string"}, "serviceId": {"type": "integer"}, "productName": {"type": "string"}, "osName": {"type": "string"}, "orderId": {"type": "integer"}, "tags": {"type": "array", "items": {"type": "string"}}, "vlanId": {"type": "integer"}, "productId": {"type": "integer"}, "hostname": {"type": "string"}, "locationName": {"type": "string"}}, "type": "object"}, "BareMetalDeviceUpdate": {"properties": {"deviceId": {"type": "integer"}, "primaryIp": {"type": "string"}, "powerStatus": {"type": "string"}, "serviceId": {"type": "integer"}, "productName": {"type": "string"}, "osName": {"type": "string"}, "orderId": {"type": "integer"}, "tags": {"type": "array", "items": {"type": "string"}}, "vlanId": {"type": "integer"}, "productId": {"type": "integer"}, "hostname": {"type": "string"}, "locationName": {"type": "string"}}, "type": "object"}, "BillingInfo": {"properties": {"achAba": {"type": "string"}, "country": {"type": "string"}, "zip": {"type": "string"}, "company": {"type": "string"}, "city": {"type": "string"}, "first": {"type": "string"}, "email": {"type": "string"}, "ccExpire": {"type": "string"}, "phone": {"type": "string"}, "achAccount": {"type": "string"}, "ccNum": {"type": "string"}, "achBank": {"type": "string"}, "paymentType": {"type": "string"}, "id": {"type": "integer"}, "status": {"type": "integer"}, "state": {"type": "string"}, "address": {"type": "string"}, "last": {"type": "string"}, "achType": {"type": "string"}, "ccType": {"type": "string"}, "clientId": {"type": "integer"}}, "type": "object"}, "CancellationCreate": {"required": ["reason", "serviceId"], "properties": {"reason": {"type": "string"}, "deviceId": {"type": "integer"}, "serviceId": {"type": "integer"}}, "type": "object"}, "Cancellation": {"properties": {"monthlyPayment": {"type": "integer"}, "name": {"type": "string"}, "deletedAt": {"type": "string", "format": "date-time"}, "deviceId": {"type": "integer"}, "planId": {"type": "integer"}, "requestDate": {"type": "string", "format": "date-time"}, "activeMonths": {"type": "integer"}, "startDate": {"type": "string", "format": "date-time"}, "id": {"type": "integer"}, "serviceId": {"type": "integer"}, "cancelled": {"type": "boolean"}, "clientId": {"type": "integer"}}, "type": "object"}, "ContactCreate": {"required": ["active", "email", "fullName"], "properties": {"email": {"type": "string"}, "password": {"type": "string", "default": "995c6cfdfac622b732e48fff9be3d495"}, "phone": {"type": "string"}, "fullName": {"type": "string"}, "description": {"type": "string"}, "active": {"type": "integer"}}, "type": "object"}, "Contact-dump": {"required": ["active", "email", "fullName"], "properties": {"active": {"type": "integer"}, "isClient": {"type": "boolean"}, "email": {"type": "string"}, "phone": {"type": "string"}, "contactId": {"type": "integer"}, "fullName": {"type": "string"}, "description": {"type": "string"}, "clientId": {"type": "integer"}}, "type": "object"}, "ContactUpdate": {"properties": {"email": {"type": "string"}, "phone": {"type": "string"}, "fullName": {"type": "string"}, "description": {"type": "string"}, "active": {"type": "integer"}}, "type": "object"}, "Password": {"required": ["newPassword", "password"], "properties": {"password": {"type": "string"}, "newPassword": {"type": "string"}}, "type": "object"}, "PasswordResponse": {"required": ["password", "token"], "properties": {"password": {"type": "string"}, "token": {"type": "string"}}, "type": "object"}, "PasswordRequest": {"required": ["email"], "properties": {"email": {"type": "string"}}, "type": "object"}, "CreateCredit": {"properties": {"amount": {"type": "number"}, "billingInfoId": {"type": "integer"}}, "type": "object"}, "Credit": {"properties": {"id": {"type": "integer"}, "amount": {"type": "number"}, "balance": {"type": "number"}, "clientId": {"type": "integer"}, "created": {"type": "integer"}, "orderId": {"type": "integer"}, "reason": {"type": "string"}, "status": {"type": "string"}, "billingInfoId": {"type": "integer"}}, "type": "object"}, "TotalActiveCredit": {"properties": {"totalActive": {"type": "number"}}, "type": "object"}, "Device": {"required": ["name"], "properties": {"deviceId": {"type": "integer"}, "name": {"type": "string"}, "status": {"type": "string"}, "deviceType": {"type": "string"}, "powerStatus": {"type": "string"}, "hostname": {"type": "string"}, "ipmiEnabled": {"type": "boolean"}, "tags": {"type": "array", "items": {"type": "string"}}, "location": {"type": "object"}, "ipAddresses": {"type": "array", "items": {"type": "string"}}, "ipmiAddress": {"type": "string"}, "serviceMonitors": {"type": "array", "items": {"type": "string"}}, "servicePlan": {"type": "integer"}, "selfProvisioning": {"type": "boolean"}, "metadata": {"type": "object"}}, "type": "object"}, "DeviceUpdate": {"properties": {"name": {"type": "string", "example": "A Descriptive Name for this Device"}, "hostname": {"type": "string", "example": "server1.mydomain.com"}}, "type": "object"}, "DeviceInterface": {"properties": {"status": {"type": "integer"}, "name": {"type": "string"}, "interfaceId": {"type": "integer"}, "private": {"type": "boolean"}, "switchName": {"type": "string"}, "switchPort": {"type": "string"}}, "type": "object"}, "DevicePower": {"properties": {"powerStatus": {"type": "string"}}, "type": "object"}, "DeviceTag": {"properties": {"tags": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "DeviceIPMIThresholds": {"required": ["thresholds"], "properties": {"thresholds": {"type": "object"}}, "type": "object"}, "UpdateDevicesIPMIThresholds": {"required": ["device_ids", "thresholds"], "properties": {"thresholds": {"type": "object"}, "device_ids": {"type": "array", "items": {"type": "integer"}}}, "type": "object"}, "DevicesIPMIThresholds": {"required": ["devices"], "properties": {"devices": {"type": "object"}}, "type": "object"}, "DeviceIPMIInfo": {"properties": {"info": {"$ref": "#/definitions/IPMIInfo"}, "sensors": {"type": "array", "items": {"$ref": "#/definitions/IPMISensor"}}}, "type": "object"}, "IPMIInfo": {"properties": {"productId": {"type": "string"}, "selDevice": {"type": "string"}, "auxFirmwareRevInfo": {"type": "string"}, "deviceAvailable": {"type": "string"}, "deviceId": {"type": "string"}, "ipmbEventReceiver": {"type": "string"}, "sdrRepositoryDevice": {"type": "string"}, "chassisDevice": {"type": "string"}, "ipmiVersion": {"type": "string"}, "manufacturerId": {"type": "string"}, "ipmbEventGenerator": {"type": "string"}, "deviceRevision": {"type": "string"}, "bridge": {"type": "string"}, "firmwareRevision": {"type": "string"}, "fruInventoryDevice": {"type": "string"}, "deviceSDRs": {"type": "string"}, "sensorDevice": {"type": "string"}}, "type": "object"}, "IPMISensor": {"properties": {"reading": {"type": "number"}, "units": {"type": "string"}, "group": {"type": "string"}, "sensorId": {"type": "string"}, "status": {"type": "boolean"}, "name": {"type": "string"}}, "type": "object"}, "IPMIValidLogin": {"required": ["valid"], "properties": {"valid": {"type": "boolean"}}, "type": "object"}, "DevicePassword": {"required": ["password"], "properties": {"password": {"type": "string"}}, "type": "object"}, "DeviceIPMIWhitelistIP": {"required": ["custIp"], "properties": {"custIp": {"type": "string"}}, "type": "object"}, "DeviceEvent": {"properties": {"time": {"type": "integer"}, "action": {"type": "string"}}, "type": "object"}, "Inventory": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/Stock"}}}, "Stock": {"properties": {"product_name": {"type": "string"}, "product_cpu": {"type": "string"}, "core": {"type": "boolean"}, "product_display_price": {"type": "number"}, "product_quarterly_price": {"type": "number"}, "monthly_location_premium": {"type": "number"}, "location": {"type": "string"}, "product_memory": {"type": "string"}, "product_annually_price": {"type": "number"}, "product_drive": {"type": "string"}, "product_cpu_cores": {"type": "string"}, "product_semi_annually_price": {"type": "number"}, "hourly_location_premium": {"type": "number"}, "product_id": {"type": "integer"}, "product_triennial_price": {"type": "number"}, "product_bandwidth": {"type": "string"}, "stock": {"type": "string"}, "edge": {"type": "boolean"}, "product_biennial_price": {"type": "number"}, "product_on_sale": {"type": "boolean"}, "product_hourly_price": {"type": "number"}, "product_monthly_price": {"type": "number"}, "product_original_price": {"type": "number"}}, "type": "object"}, "Invoice": {"properties": {"id": {"type": "integer"}, "amount": {"type": "number"}, "amountUnpaid": {"type": "number"}, "clientId": {"type": "integer"}, "created": {"type": "integer"}, "datePaid": {"type": "integer"}, "due": {"type": "integer"}, "sent": {"type": "integer"}, "status": {"type": "string"}}, "type": "object"}, "InvoicePDF": {"properties": {"invoiceId": {"type": "integer"}, "pdfData": {"type": "string"}}, "type": "object"}, "InvoiceDetails": {"properties": {"accountBalance": {"type": "number"}, "clientAddress": {"type": "string"}, "clientName": {"type": "string"}, "companyName": {"type": "string"}, "invoiceDate": {"type": "string", "format": "date-time"}, "invoiceDue": {"type": "string", "format": "date-time"}, "invoiceNumber": {"type": "string"}, "serviceItems": {"$ref": "#/definitions/InvoiceDetailsServiceItems"}, "taxesValue": {"type": "number"}, "totalDue": {"type": "number"}, "paymentHistory": {"type": "array", "items": {"type": "object"}}, "refundHistory": {"type": "array", "items": {"type": "object"}}, "taxesList": {"type": "array", "items": {"type": "object"}}, "priorBalance": {"type": "number"}, "paymentsRefunds": {"type": "number"}}, "type": "object"}, "InvoiceDetailsServiceItems": {"properties": {"serviceId": {"type": "integer"}, "dateRange": {"type": "object"}, "unitPrice": {"type": "number"}, "description": {"type": "string"}, "quantity": {"type": "integer"}}, "type": "object"}, "Order-dump": {"properties": {"total": {"type": "number"}, "info": {"type": "object"}, "orderId": {"type": "integer"}, "status": {"type": "string"}, "owner": {"type": "string"}}, "type": "object"}, "Permission": {"required": ["permissions", "userId"], "properties": {"userId": {"type": "integer"}, "permissions": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "PermissionReturn": {"properties": {"name": {"type": "string"}}, "type": "object"}, "ProductInfo": {"properties": {"product_name": {"type": "string"}, "product_cpu": {"type": "string"}, "core": {"type": "boolean"}, "product_display_price": {"type": "number"}, "product_quarterly_price": {"type": "number"}, "monthly_location_premium": {"type": "number"}, "location": {"type": "string"}, "product_memory": {"type": "string"}, "product_annually_price": {"type": "number"}, "product_drive": {"type": "string"}, "product_cpu_cores": {"type": "string"}, "product_semi_annually_price": {"type": "number"}, "hourly_location_premium": {"type": "number"}, "product_id": {"type": "integer"}, "product_triennial_price": {"type": "number"}, "product_bandwidth": {"type": "string"}, "stock": {"type": "string"}, "edge": {"type": "boolean"}, "product_biennial_price": {"type": "number"}, "product_on_sale": {"type": "boolean"}, "product_hourly_price": {"type": "number"}, "product_monthly_price": {"type": "number"}, "product_original_price": {"type": "number"}}, "type": "object"}, "ProductMatch": {"properties": {"lshwOutput": {"type": "object"}, "spsOnly": {"type": "boolean", "example": true}}, "type": "object"}, "ProductMatchResult": {"properties": {"possibleMatches": {"$ref": "#/definitions/Product"}, "matches": {"$ref": "#/definitions/Product"}}, "type": "object"}, "Product": {"properties": {"drive": {"type": "string"}, "stock": {"type": "integer"}, "cpu": {"type": "string"}, "new": {"type": "integer"}, "isSps": {"type": "boolean"}, "memory": {"type": "string"}, "planId": {"type": "integer"}, "name": {"type": "string"}, "id": {"type": "integer"}, "discount": {"type": "number"}, "originalPrice": {"type": "number"}, "sale": {"type": "integer"}}, "type": "object"}, "Options": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/Option"}}}, "Option": {"properties": {"name": {"type": "string"}, "tags": {"type": "array", "items": {"type": "string"}}, "currency": {"type": "string"}, "id": {"type": "integer"}, "monthlyPrice": {"type": "number"}, "expressions": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "ProfileUpdate": {"properties": {"address": {"type": "string"}, "city": {"type": "string"}, "first": {"type": "string"}, "last": {"type": "string"}, "email": {"type": "string"}, "country": {"type": "string"}, "full_name": {"type": "string"}, "phone": {"type": "string"}, "zip": {"type": "string"}, "state": {"type": "string"}, "company": {"type": "string"}}, "type": "object"}, "Profile": {"properties": {"address": {"type": "object"}, "city": {"type": "object"}, "first": {"type": "string"}, "last": {"type": "string"}, "email": {"type": "string"}, "country": {"type": "object"}, "login": {"type": "string"}, "full_name": {"type": "object"}, "zip": {"type": "object"}, "meta_data": {"type": "object"}, "phone": {"type": "string"}, "id": {"type": "integer"}, "fax": {"type": "object"}, "is_client": {"type": "boolean"}, "created": {"type": "object"}, "state": {"type": "object"}, "company": {"type": "object"}}, "type": "object"}, "BasicProfile": {"properties": {"city": {"type": "object"}, "first": {"type": "string"}, "last": {"type": "string"}, "email": {"type": "string"}, "country": {"type": "object"}, "login": {"type": "string"}, "full_name": {"type": "object"}, "zip": {"type": "object"}, "meta_data": {"type": "object"}, "id": {"type": "integer"}, "is_client": {"type": "boolean"}, "state": {"type": "object"}, "company": {"type": "object"}}, "type": "object"}, "Deployment": {"properties": {"orderNumber": {"type": "string"}, "startedProvisioning": {"type": "boolean"}, "empty": {"type": "boolean"}, "deploymentName": {"type": "string"}, "deploymentId": {"type": "integer"}, "price": {"type": "number"}, "deploymentConfiguration": {"type": "array", "items": {"type": "object"}}}, "type": "object"}, "DeploymentCustomization": {"required": ["hostnames", "operatingSystem", "productId"], "properties": {"productId": {"type": "integer"}, "hostnames": {"type": "array", "items": {"type": "string"}}, "options": {"type": "array", "default": [], "items": {"type": "integer"}}, "locationCode": {"type": "string", "default": ""}, "additionalNotes": {"type": "array", "items": {"type": "string"}}, "billingPeriod": {"type": "string", "description": "must be one of ['monthly', 'quarterly', 'semi-annually', 'annually', 'biennial', 'triennial', 'hourly']", "default": "monthly"}, "operatingSystem": {"type": "string", "description": "Operating System's Name or ID"}, "quantity": {"type": "integer", "default": 1}}, "type": "object"}, "DeploymentStart": {"required": ["billingInfo"], "properties": {"billingInfo": {"type": "integer"}}, "type": "object"}, "Service-dump": {"properties": {"serviceId": {"type": "integer"}, "created": {"type": "integer"}, "billedPrice": {"type": "number"}, "billedPricePerPeriod": {"type": "number"}, "serviceCost": {"type": "number"}, "lastRenew": {"type": "integer"}, "renewDate": {"type": "integer"}, "quantity": {"type": "number"}, "orderId": {"type": "integer"}, "status": {"type": "string"}, "period": {"type": "string"}, "discount": {"type": "number"}, "discountType": {"type": "string"}, "discountedCost": {"type": "number"}, "serviceDiscount": {"type": "number"}, "serviceDiscountPerPeriod": {"type": "number"}, "ipAddress": {"type": "string"}, "cancelAfter": {"type": "integer"}, "startDate": {"type": "integer"}, "endDate": {"type": "integer"}, "serviceOptions": {"$ref": "#/definitions/ServiceOption"}, "serviceDevices": {"type": "array", "items": {"type": "object"}}, "childServices": {"type": "array", "items": {"type": "object"}}, "productId": {"type": "integer"}, "productName": {"type": "string"}, "reseller": {"type": "string"}, "serviceType": {"type": "string"}, "contractTerm": {"type": "integer"}, "billingInfoId": {"type": "integer"}}, "type": "object"}, "ServiceOption": {"properties": {"serviceOptionId": {"type": "integer"}, "name": {"type": "string"}, "optionId": {"type": "integer"}, "upgradeName": {"type": "string"}, "groupName": {"type": "string"}, "invoiceHide": {"type": "string"}}, "type": "object"}, "SshKey": {"required": ["name", "publicKey"], "properties": {"publicKey": {"type": "string"}, "name": {"type": "string"}}, "type": "object"}, "SshKeyResponse": {"properties": {"sshKeyId": {"type": "integer"}, "publicKey": {"type": "string"}, "name": {"type": "string"}}, "type": "object"}, "SshKeyUpdate": {"properties": {"publicKey": {"type": "string"}, "name": {"type": "string"}}, "type": "object"}, "TicketCreate": {"required": ["queue", "subject"], "properties": {"body": {"type": "string"}, "subject": {"type": "string"}, "status": {"type": "string", "example": "open"}, "queue": {"type": "string"}, "source": {"type": "number"}, "priority": {"type": "number"}, "assignment": {"type": "number"}}, "type": "object"}, "Ticket": {"properties": {"status": {"type": "string"}, "subject": {"type": "string"}, "queue": {"type": "string"}, "updated": {"type": "number"}, "opened": {"type": "number", "example": 1602779507}, "serviceId": {"type": "number"}, "client": {"$ref": "#/definitions/Client"}, "priority": {"type": "string"}, "id": {"type": "number"}, "posts": {"type": "number"}, "contact": {"$ref": "#/definitions/Contact-dump"}, "body": {"type": "string"}, "newReply": {"type": "boolean"}, "metaData": {"type": "object"}, "replies": {"$ref": "#/definitions/TicketPost"}, "clientId": {"type": "number"}, "contactId": {"type": "number"}, "duration": {"type": "number"}, "internalTicket": {"type": "number"}}, "type": "object"}, "Client": {"properties": {"city": {"type": "string"}, "last": {"type": "string"}, "first": {"type": "string"}, "isClient": {"type": "boolean"}, "email": {"type": "string"}, "country": {"type": "string"}, "login": {"type": "string"}, "zip": {"type": "string"}, "id": {"type": "number"}, "state": {"type": "string"}, "fullName": {"type": "string"}, "metaData": {"type": "object"}, "company": {"type": "string"}}, "type": "object"}, "TicketPost": {"properties": {"attachments": {"type": "number"}, "fromAdmin": {"type": "boolean"}, "body": {"type": "string"}, "from": {"type": "object"}, "subject": {"type": "string"}, "date": {"type": "number"}, "hidden": {"type": "number"}, "contactId": {"type": "number"}, "id": {"type": "number"}, "ticketId": {"type": "number"}, "adminId": {"type": "number"}, "ubersmith_attached_files": {"$ref": "#/definitions/TicketAttach"}, "clientId": {"type": "number"}}, "type": "object"}, "TicketAttach": {"properties": {"id": {"type": "number"}, "name": {"type": "string"}}, "type": "object"}, "TicketSeachResult": {"properties": {"pages": {"type": "integer"}, "page": {"type": "integer"}, "total": {"type": "integer"}, "prevPage": {"type": "integer"}, "hasPrev": {"type": "boolean"}, "perPage": {"type": "integer"}, "items": {"$ref": "#/definitions/TicketPost"}, "nextPage": {"type": "integer"}, "hasNext": {"type": "boolean"}}, "type": "object"}, "TicketPut": {"properties": {"status": {"type": "string"}}, "type": "object"}, "TicketCreateReply": {"required": ["body"], "properties": {"attachments": {"type": "array", "example": [{"name": "", "file": ""}], "items": {"type": "object"}}, "headers": {"type": "string"}, "body": {"type": "string"}, "replyTo": {"type": "string"}, "subject": {"type": "string"}, "date": {"type": "number"}, "hidden": {"type": "number"}, "contactId": {"type": "number"}, "cc": {"type": "string"}, "type": {"type": "number"}, "encrypted": {"type": "string"}, "recipient": {"type": "string"}}, "type": "object"}, "PublicApiToken-load": {"properties": {"name": {"type": "string"}}, "type": "object"}, "PublicApiToken-dump": {"required": ["token"], "properties": {"token": {"type": "string"}, "name": {"type": "string"}}, "type": "object"}, "WebhookEvent": {"required": ["desc", "name"], "properties": {"name": {"type": "string"}, "desc": {"type": "string"}}, "type": "object"}, "WebhookCreate": {"required": ["event", "url"], "properties": {"name": {"type": "string", "example": "My Webhook"}, "event": {"type": "string"}, "url": {"type": "string"}, "headers": {"type": "object"}}, "type": "object"}, "Webhook": {"required": ["event", "name", "url", "webhookId"], "properties": {"webhookId": {"type": "integer"}, "name": {"type": "string"}, "event": {"type": "string"}, "url": {"type": "string"}, "headers": {"type": "object"}}, "type": "object"}, "WebhookUpdate": {"properties": {"name": {"type": "string", "example": "My Webhook"}, "event": {"type": "string"}, "url": {"type": "string"}, "headers": {"type": "object"}}, "type": "object"}}, "responses": {"ParseError": {"description": "When a mask can't be parsed"}, "MaskError": {"description": "When any error occurs on mask"}}}