--- updatedAt: 2026-05-27T19:42:41.000Z agentTools: projectIndex: https://developers.hivelocity.net/llms.txt --- # Get device # OpenAPI definition ```json { "openapi": "3.0.0", "paths": { "/device/{deviceId}": { "get": { "operationId": "get_device_id_resource", "parameters": [ { "description": "An optional fields mask", "in": "header", "name": "X-Fields", "schema": { "type": "string", "format": "mask" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device-dump" } } } }, "403": { "description": "You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission." } }, "summary": "Get device", "tags": [ "Device" ] }, "parameters": [ { "description": "ID of Device to View / Update", "in": "path", "name": "deviceId", "required": true, "schema": { "type": "integer" } } ] } }, "info": { "description": "Interact with Hivelocity", "title": "Hivelocity API", "version": "2.0" }, "security": [ { "apiKey": [] } ], "tags": [ { "description": "Access to your Bare-Metal or Virtual Devices", "name": "Device" } ], "servers": [ { "url": "https://core.hivelocity.net/api/v2" } ], "components": { "securitySchemes": { "apiKey": { "in": "header", "name": "X-API-KEY", "type": "apiKey" } }, "schemas": { "AppColors": { "properties": { "accents": { "description": "Pair of gradient accent colors (e.g. [\"#15d6a0\", \"#00b4c8\"])", "items": { "type": "string" }, "type": "array" }, "tint": { "description": "Primary solid color for the app theme (e.g. \"#006750\")", "type": "string" } }, "required": [ "accents", "tint" ], "type": "object" }, "AppForm": { "properties": { "form_builder": { "allOf": [ { "$ref": "#/components/schemas/FormBuilderLayout" } ], "description": "Form builder layout used to edit the form in Internal Tools" }, "json_schema": { "allOf": [ { "$ref": "#/components/schemas/JSONSchemaLayout" } ], "description": "Schema used to validate an App's form data" }, "test_data": { "description": "Test data used to validate the form", "type": "object" } }, "required": [ "form_builder" ], "type": "object" }, "AppResponse": { "properties": { "admin_id": { "description": "ID of the admin that created the application", "type": "integer" }, "admin_name": { "description": "Name admin that created the application", "type": "string" }, "app_form": { "allOf": [ { "$ref": "#/components/schemas/AppForm" } ], "description": "Schema of the form, this is used to determine what fields are available and what kind of data they will accept" }, "categories": { "description": "Names of the categories this app belongs to (resolved from category_ids)", "items": { "type": "string" }, "type": "array" }, "category_ids": { "description": "IDs of the app categories (see /apps/categories) this app belongs to", "items": { "type": "integer" }, "type": "array" }, "changed": { "description": "Date and time the application was last changed", "format": "date-time", "type": "string" }, "changed_ts": { "type": "integer" }, "cloud_init_template": { "description": "Cloud init template for the application, this is used to provide the cloud init configuration for the application. The templating syntax is Jinja2", "type": "string" }, "colors": { "allOf": [ { "$ref": "#/components/schemas/AppColors" } ], "description": "Theme colors for the app in the store" }, "created": { "description": "Date and time the application was created", "format": "date-time", "type": "string" }, "created_ts": { "type": "integer" }, "description": { "description": "Description of the application, this is used to provide context to the user", "type": "string" }, "help_text_template": { "description": "Markdown help doc for the application, this is used to provide documentation to the application and its form requirements", "type": "string" }, "id": { "description": "ID of the application", "type": "integer" }, "image_url": { "description": "URL of the image for the app option to display in store", "type": "string" }, "included_features": { "description": "Marketed bullet points / features for this app", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Name of the application, this is used as a verbatim key in configuration data", "type": "string" }, "set_no_app_form": { "description": "Set this to true to disable the form for this application, this is used to disable the form for applications that do not require user input. App form most NOT be supplied when this is true for updating apps. This was is a workaround for swagger typescript generation not supporting nullable fields.", "type": "boolean" }, "sps_app_option_id": { "description": "ID of the SPS app-option to link to this app", "type": "integer", "x-optionList": "sps_app_options" }, "sps_app_option_name": { "description": "Name of the SPS App option linked to", "type": "string" }, "sps_base_os_option_id": { "description": "ID of the base SPS OS option to link to this app", "type": "integer", "x-optionList": "sps_os_options" }, "sps_base_os_option_name": { "description": "Name of the base SPS OS option linked to this app", "type": "string" }, "tag_ids": { "description": "IDs of the app tags (see /apps/tags) applied to this app", "items": { "type": "integer" }, "type": "array" }, "tags": { "description": "Names of the tags applied to this app (resolved from tag_ids)", "items": { "type": "string" }, "type": "array" }, "title": { "description": "Title of the application, this is used to provide context to the user", "type": "string" }, "vps_app_option_id": { "description": "ID of the VPS app-option to link to this app", "type": "integer", "x-optionList": "vps_app_options" }, "vps_app_option_name": { "description": "Name of the VPS App option linked to", "type": "string" }, "vps_base_os_option_id": { "description": "ID of the base VPS OS option to link to this app", "type": "integer", "x-optionList": "vps_os_options" }, "vps_base_os_option_name": { "description": "Name of the base VPS OS option linked to this app", "type": "string" } }, "required": [ "admin_id", "admin_name", "categories", "changed", "changed_ts", "created", "created_ts", "id", "name", "sps_base_os_option_id", "sps_base_os_option_name", "tags", "title", "vps_base_os_option_id", "vps_base_os_option_name" ], "type": "object", "x-propertyOrder": [ "name", "title", "description", "app_form", "set_no_app_form", "help_text_template", "cloud_init_template", "image_url", "vps_app_option_id", "vps_base_os_option_id", "sps_app_option_id", "sps_base_os_option_id", "category_ids", "tag_ids", "included_features", "colors", "id", "admin_id", "admin_name", "created", "changed", "created_ts", "changed_ts", "sps_base_os_option_name", "vps_base_os_option_name", "sps_app_option_name", "vps_app_option_name", "categories", "tags" ], "x-propertyTitles": { "admin_id": "Admin ID", "admin_name": "Admin Name", "app_form": "Form Schema", "categories": "Categories", "category_ids": "Category IDs", "changed": "Changed", "cloud_init_template": "Cloud Init Template", "colors": "Colors", "created": "Created", "description": "Description", "help_text_template": "Help Text", "id": "ID", "image_url": "Image URL", "included_features": "Included Features", "name": "Name", "set_no_app_form": "Set No Form", "sps_app_option_id": "SPS Option ID", "sps_app_option_name": "SPS App Option Name", "sps_base_os_option_id": "SPS Base OS Option ID", "sps_base_os_option_name": "Base SPS OS Option Name", "tag_ids": "Tag IDs", "tags": "Tags", "title": "Title", "vps_app_option_id": "VPS Option ID", "vps_app_option_name": "VPS App Option Name", "vps_base_os_option_id": "VPS Base OS Option ID", "vps_base_os_option_name": "Base VPS OS Option Name" } }, "Device-dump": { "properties": { "billingCancelDate": { "description": "Device's service expected cancel date.", "type": "integer" }, "billingInfo": { "description": "If set, detailed info on this device's billing method. Otherwise null. When null the accounts default billing info is used for payments.", "type": "object" }, "billingStatus": { "description": "Device's service billing status.", "type": "string" }, "canReload": { "description": "True when the device's current state permits a reload. Gate reload controls on this rather than on `isReload`: a custom iPXE device reports as reloading while the customer's script runs, yet may still be reloaded.", "type": "boolean" }, "clientId": { "description": "The unique ID of the associated client.", "type": "integer" }, "createdDate": { "description": "Date of service creation.", "type": "string" }, "currentApp": { "allOf": [ { "$ref": "#/components/schemas/AppResponse" } ], "description": "The current app installed on the device." }, "currentAppOption": { "allOf": [ { "$ref": "#/components/schemas/Option-dump" } ], "description": "The current app option installed on the device." }, "deviceId": { "description": "The unique ID of the device.", "type": "integer" }, "deviceType": { "description": "Generic description of device. Usually type and rack unit size.", "type": "string" }, "deviceTypeGroup": { "description": "Generic group", "type": "string" }, "displayedTags": { "description": "List containing key/values of device info based on tag order.", "items": { "type": "object" }, "type": "array" }, "enterpriseCloud": { "allOf": [ { "$ref": "#/components/schemas/PrivateCloudDevice" } ], "description": "Enterprise Cloud information" }, "hardwareUpgradeCancelled": { "description": "Whether the hardware upgrade request has been cancelled.", "type": "boolean" }, "hardwareUpgradeTicketId": { "description": "Zendesk ticket ID for a pending hardware upgrade request, if any.", "type": "integer" }, "hasCancellation": { "description": "True if device has active cancellation request.", "type": "boolean" }, "hostname": { "description": "a fqdn for the device. for example: `example.hivelocity.net`.", "type": "string" }, "ipmiAddress": { "description": "IP address for IPMI connection. Requires you to whitelist your current IP or be on IPMI VPN.", "type": "object" }, "ipmiEnabled": { "description": "True if device is accessible over IPMI by customer.", "type": "boolean" }, "isManaged": { "description": "True if device enrolled in managed services.", "type": "boolean" }, "isProvisioning": { "description": "True if device is currently being provisioned.", "type": "boolean" }, "isReload": { "description": "True if device currently reloading.", "type": "boolean" }, "lastInvoiceId": { "description": "The unique ID of the last invoice for this device.", "type": "integer" }, "location": { "description": "Detailed information on the device location.", "type": "object" }, "managedAlertsTotal": { "description": "# of managed service alerts.", "type": "integer" }, "metadata": { "description": "Additional metadata.", "type": "object" }, "monitorsTotal": { "description": "Total # device monitors", "type": "integer" }, "monitorsUp": { "description": "# of passing device monitors", "type": "integer" }, "name": { "description": "User given custom name.", "type": "string" }, "networkAutomation": { "description": "Network Automation status for device.", "type": "object" }, "nextBillingDate": { "description": "Date of next invoice determined by associated service.", "type": "integer" }, "nextBillingValue": { "description": "Price of device to be paid at `nextBillingDate` determined by associated service.", "type": "number" }, "ports": { "description": "Device Ports (Network Interfaces).", "items": { "type": "object" }, "type": "array" }, "powerStatus": { "description": "ON|OFF", "type": "object" }, "primaryIp": { "description": "The first assigned public IP for accessing this device.", "type": "string" }, "productId": { "description": "The product ID for the device.", "type": "integer" }, "provisioningOs": { "description": "OS being provisioned on the device.", "type": "string" }, "provisioningProgress": { "description": "Current provisioning stage: pending|pxe|network_setup|disk_setup|installation|configuration|post_network|finalizing|end", "type": "string" }, "reloadBlockedReason": { "description": "Why a reload is not currently permitted, suitable for display. Null when `canReload` is true.", "type": "string" }, "selfProvisioning": { "description": "True if instant server.", "type": "boolean" }, "serviceMonitors": { "items": { "type": "string" }, "type": "array" }, "servicePlan": { "description": "The unique ID of the associated service.", "type": "integer" }, "sharedHosting": { "allOf": [ { "$ref": "#/components/schemas/ShareHostingDeviceDetails" } ], "description": "Share Hosting information" }, "spsStatus": { "description": "BUILDING|IPMI_READY|PROVISIONABLE|RESERVED|WAIT_FOR_PXE|PROVISION_STARTED|PROVISION_WAIT_FOR_ADDONS|PROVISION_FINISHED|WAIT_TO_COMPLETE_ORDER|WAIT_TO_ASSIGN_SERVICE|WAIT_FOR_HARDWARE_SCAN|IN_USE|RELOADING|DEVICE_READY_TO_TEST|DEVICE_READY_TO_WIPE|DEVICE_READY_TO_UPGRADE_FIRMWARE|FAILED|CLEANUP_MOVE_TO_FAILED|IN_REVIEW|READY_FOR_MIGRATION", "type": "string" }, "status": { "description": "active|inactive", "type": "string" }, "tags": { "description": "List of all user set device tags.", "items": { "type": "string" }, "type": "array" }, "willInterruptCustomIPXE": { "description": "True when a custom iPXE script is running, so reloading now would cut it short.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "FormBuilderLayout": { "properties": { "definitions": { "type": "object" }, "main": { "type": "object" } }, "required": [ "definitions", "main" ], "type": "object" }, "JSONSchemaLayout": { "properties": { "definitions": { "description": "Definitions used to validate an App's form data", "type": "object" }, "schema": { "description": "Schema used to validate an App's form data", "type": "object" } }, "required": [ "definitions", "schema" ], "type": "object" }, "OperatingSystem": { "properties": { "cloudInit": { "type": "boolean" }, "postInstall": { "type": "boolean" }, "sshKey": { "type": "boolean" } }, "type": "object" }, "Option-dump": { "properties": { "currency": { "description": "USD|other", "type": "string" }, "expressions": { "description": "Used with `tags` to determine option compatibility. See product docs.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Unique ID of the option. Stays the same across products.", "type": "integer" }, "monthlyPrice": { "description": "Monthly price of the option.", "type": "number" }, "name": { "description": "Unique option name.", "type": "string" }, "operatingSystemFeatures": { "$ref": "#/components/schemas/OperatingSystem" }, "tags": { "description": "Used with `expressions` to determine option compatibility. See product docs.", "items": { "type": "string" }, "type": "array" }, "upgradeName": { "description": "Name of the upgrade this option belongs to; used to label required-style group selectors (e.g. the reload license picker).", "type": "string" } }, "required": [ "name" ], "type": "object" }, "PrivateCloudDevice": { "properties": { "vdcDetails": { "description": "Details of the VDC.", "type": "string" }, "vdcID": { "description": "The unique ID of the VDC.", "type": "string" } }, "type": "object" }, "ShareHostingDeviceDetails": { "properties": { "hostingType": { "type": "string" }, "hostname": { "type": "string" }, "username": { "type": "string" } }, "required": [ "hostingType", "hostname" ], "type": "object" } } } } ```