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

# Provision an instant device

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/compute/": {
      "post": {
        "operationId": "post_compute_resource",
        "parameters": [
          {
            "description": "An optional fields mask",
            "in": "header",
            "name": "X-Fields",
            "schema": {
              "type": "string",
              "format": "mask"
            }
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/BareMetalDeviceCreate"
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BareMetalDevice"
                }
              }
            }
          },
          "201": {
            "description": "Device provisioning started"
          },
          "400": {
            "description": "Invalid device parameters."
          },
          "403": {
            "description": "You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission."
          }
        },
        "summary": "Provision an instant device",
        "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": {
    "requestBodies": {
      "BareMetalDeviceCreate": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/BareMetalDeviceCreate"
            }
          }
        },
        "required": true
      }
    },
    "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"
      },
      "BareMetalDeviceCreate": {
        "properties": {
          "bondingSupport": {
            "description": "If true, ensures the provisioned device supports port bonding. If false, ensures no bonding support.",
            "type": "boolean"
          },
          "customIPXEScriptContents": {
            "description": "Contents of iPXE script if not supplying URL",
            "type": "string"
          },
          "customIPXEScriptURL": {
            "description": "URL to download custom iPXE script if not supplying script in entirety",
            "type": "string"
          },
          "forceCustomIPXEDownload": {
            "default": false,
            "description": "Bypass the validation of the custom iPXE script contained in the URL and download the script regardless.",
            "example": false,
            "type": "boolean"
          },
          "forceDeviceId": {
            "description": "For users with reserved devices. The unique ID of the target device to provision.",
            "type": "integer"
          },
          "hostname": {
            "description": "A FQDN for the device. For example: `example.hivelocity.net`",
            "type": "string"
          },
          "ignitionId": {
            "description": "The unique ID of an Ignition File for FlatcarOS provisions.",
            "type": "integer"
          },
          "locationName": {
            "description": "A facility code. For example `NYC1`.",
            "type": "string"
          },
          "osName": {
            "description": "The name of the Operating System to provision on this device. Must match name of an operating system product option.",
            "type": "string"
          },
          "period": {
            "default": "hourly",
            "description": "hourly|monthly|quarterly|semi-annually|annually|biennial|triennial",
            "example": "hourly",
            "type": "string"
          },
          "productId": {
            "description": "The unique ID of the desired product to provision.",
            "type": "integer"
          },
          "publicSshKeyId": {
            "type": "integer"
          },
          "script": {
            "description": "A Cloud-Init script or a post-install script (Bash for Linux or Powershell for Windows).",
            "type": "string"
          },
          "tags": {
            "default": [],
            "description": "User specified values.",
            "example": [],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "vlanId": {
            "type": "integer"
          }
        },
        "required": [
          "hostname",
          "locationName",
          "osName",
          "productId"
        ],
        "type": "object"
      }
    }
  }
}
```