Device

Update device

put/device/{deviceId}

Request

  • Base URL
    https://core.hivelocity.net/api/v2
  • URL
    https://core.hivelocity.net/api/v2/device/{deviceId}
  • Auth
    API key in header X-API-KEY

Headers

X-Fieldsstring mask

An optional fields mask

Request body

hostnamestring

A FQDN for the device. For example: example.hivelocity.net.

namestring

Example request

{
  "hostname": "server1.mydomain.com",
  "name": "User given custom name"
}

Response

Device MetaData was updated.

billingCancelDateinteger

Device's service expected cancel date.

billingInfoobject

If set, detailed info on this device's billing method. Otherwise null. When null the accounts default billing info is used for payments.

billingStatusstring

Device's service billing status.

clientIdinteger

The unique ID of the associated client.

createdDatestring

Date of service creation.

deviceIdinteger

The unique ID of the device.

deviceTypestring

Generic description of device. Usually type and rack unit size.

deviceTypeGroupstring

Generic group

displayedTagsobject[]

List containing key/values of device info based on tag order.

hardwareUpgradeCancelledboolean

Whether the hardware upgrade request has been cancelled.

hardwareUpgradeTicketIdinteger

Zendesk ticket ID for a pending hardware upgrade request, if any.

hasCancellationboolean

True if device has active cancellation request.

hostnamestring

a fqdn for the device. for example: example.hivelocity.net.

ipmiAddressobject

IP address for IPMI connection. Requires you to whitelist your current IP or be on IPMI VPN.

ipmiEnabledboolean

True if device is accessible over IPMI by customer.

isManagedboolean

True if device enrolled in managed services.

isReloadboolean

True if device currently reloading.

lastInvoiceIdinteger

The unique ID of the last invoice for this device.

locationobject

Detailed information on the device location.

managedAlertsTotalinteger

of managed service alerts.

metadataobject

Additional metadata.

monitorsTotalinteger

Total # device monitors

monitorsUpinteger

of passing device monitors

namestring required

User given custom name.

networkAutomationobject

Network Automation status for device.

nextBillingDateinteger

Date of next invoice determined by associated service.

nextBillingValuenumber

Price of device to be paid at nextBillingDate determined by associated service.

portsobject[]

Device Ports (Network Interfaces).

powerStatusobject

ON|OFF

primaryIpstring

The first assigned public IP for accessing this device.

productIdinteger

The product ID for the device.

selfProvisioningboolean

True if instant server.

serviceMonitorsstring[]
servicePlaninteger

The unique ID of the associated service.

spsStatusstring

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

statusstring

active|inactive

tagsstring[]

List of all user set device tags.

Changes

No recorded changes to this operation across all 1 revision of this API.