VPS

Get all VPS instances

get/vps/

Request

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

Query parameters

clientIdinteger

The unique client account ID.

facilityCodestring

The facility code associated with the VPS instance. For example: TPA1.

hostIdstring

Host ID (hypervisor) of the VPS instance.

networkIdstring

The Network ID the VPS instance is attached to.

storageIdstring

The storage server ID of the VPS instance.

Headers

X-Fieldsstring mask

An optional fields mask

Response

VPS instances retrieved successfuly

cloudInitstring

Cloud-init script

deviceIdinteger

Device ID

facilityCodestring

Facility Code. Example: LAX3

isoIdstring

The unique ID of the VPS ISO.

memoryinteger

Memory in MB

passwordstring

VPS Instance root password

sshKeyIdsinteger[]

List of SSH Key IDs

statusstring

VPS Instance Status. Example: Running

templateIdstring

Template used for the install

vcpuinteger

Number of vCPUs

Changes

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