---
updatedAt: 2026-05-27T19:42:41.000Z
agentTools:
  projectIndex: https://developers.hivelocity.net/llms.txt
---

# Get all devices

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/compute/": {
      "get": {
        "operationId": "get_compute_resource",
        "parameters": [
          {
            "description": "An optional fields mask",
            "in": "header",
            "name": "X-Fields",
            "schema": {
              "type": "string",
              "format": "mask"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Devices found successfuly",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/BareMetalDevice"
                  },
                  "type": "array"
                }
              }
            }
          },
          "403": {
            "description": "You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission."
          }
        },
        "summary": "Get all devices",
        "tags": [
          "Compute Devices"
        ]
      }
    }
  },
  "info": {
    "description": "Interact with Hivelocity",
    "title": "Hivelocity API",
    "version": "2.0"
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    {
      "description": "Endpoints to handle compute devices.",
      "name": "Compute Devices"
    }
  ],
  "servers": [
    {
      "url": "https://core.hivelocity.net/api/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "apiKey": {
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey"
      }
    },
    "schemas": {
      "BareMetalDevice": {
        "properties": {
          "appName": {
            "description": "If device was deployed with as an application, this is the name of the application used.",
            "type": "string"
          },
          "customIPXEScriptContents": {
            "description": "Contents of custom iPXE used to provision device",
            "type": "string"
          },
          "customIPXEScriptURL": {
            "description": "URL of custom iPXE script used to provision device",
            "type": "string"
          },
          "deviceId": {
            "description": "The unique ID of the device.",
            "type": "integer"
          },
          "hostname": {
            "description": "The user specified hostname for the device. Note: If the hostname is changed in the portal or on the device itself this value may not reflect the actual hostname on the device.",
            "type": "string"
          },
          "locationName": {
            "description": "A facility code. For example `NYC1`.",
            "type": "string"
          },
          "orderId": {
            "description": "The unique ID of the order for this device.",
            "type": "integer"
          },
          "osName": {
            "description": "The name of the operating system currently installed on this device. Note: If you manually reload your own OS over IPMI this value may not reflect the OS currently on your device.",
            "type": "string"
          },
          "period": {
            "description": "This device's service's billing period.",
            "example": "hourly",
            "type": "string"
          },
          "powerStatus": {
            "description": "ON|OFF",
            "type": "string"
          },
          "primaryIp": {
            "description": "The first assigned public IP for accessing this device.",
            "type": "string"
          },
          "productId": {
            "description": "The unique ID of the product associated with this device.",
            "type": "integer"
          },
          "productName": {
            "description": "The name of the product associated with this device.",
            "type": "string"
          },
          "publicSshKeyId": {
            "type": "integer"
          },
          "script": {
            "description": "The post-install/cloud-init script used during this device's last provisioning.",
            "type": "string"
          },
          "serviceId": {
            "description": "The unique ID of the service associated with this device.",
            "type": "integer"
          },
          "tags": {
            "description": "User specified values.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "vlanId": {
            "type": "integer"
          }
        },
        "type": "object"
      }
    }
  }
}
```