Whenever you deploy a server with Hivelocity, an order is created during the provisioning process. This order keeps track of a variety of things. For Instant servers, it tracks the status of your provisioning. For Custom servers, it tracks the status of procurement, building, and provisioning of your server.

Orders that include at least one of each type of deployment - instant server and custom server - will be split into two orders to ensure your instant servers are provisioned immediately.

Getting Orders

Getting a Single Order

All deployment requests to the API will return an orderId which you can use to track your order. To get a specific order, make a GET request to /order/ORDER_ID.

curl -X 'GET' \
  'https://core-prod.stacklocity.net/api/v2/order/ORDER_ID' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: $API_KEY'

You can also view the status of your order on the Device List section of the portal.

Getting all Orders

Orders are permanent and will continue to exist on your client account, even if you delete your server. You will still be able to retrieve its original order. This can be helpful when you want to recreate a similar deployment from the past but didn't use a configuration management tool like Terraform. To get a list of your orders, make a GET request to /order.

curl -X 'GET' \
  'https://core.hivelocity.net/api/v2/order/' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: $API_KEY'