/
HI
hivelocity
/
Hivelocity API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2w ago · Updated 2w ago
View markdown
hivelocity
Hivelocity API
post
Create a one time use URL for console access to a VPS instance
v1
latest
OpenAPI 3.0.0
2026-07-26
258
182
277.4 KB
Account
3
Apps
3
Backup
1
Bandwidth
4
Bare Metal Devices
6
BillingInfo
10
Cancellations
6
Compute Devices
6
Contact
8
Credit
5
Deployment
6
Device
38
Domains
23
Ignition
5
Inventory
3
Invoice
9
IPAssignment
9
Maintenance
2
Network
8
option
1
Order
7
Order Groups
5
Permission
4
PrivateCloud
1
Product
3
Profile
4
RapidRestore
1
SAML
3
Service
7
SshKey
5
Token
4
VLAN
6
VPS
44
get
Get available upgrade options for a VPS product
get
Get available upgrade options for a VPS product
get
Get all VPS instances
get
Gets list of available sizes for new volumes
get
Get all VPS ISOs available
post
Create a new ISO
get
Get the details of the VPS ISO ID specified
delete
Delete an ISO
get
Get all VPS Networks
post
Create a new VPS Network
get
Get VPS Network
put
Update VPS Network
delete
Delete VPS Network
get
Get all VPS Volume Snapshots available
post
Create a VPS Volume Snapshot
get
Get a VPS Volume Snapshot by ID
post
Restore a VPS Volume Snapshot
delete
Delete a VPS Volume Snapshot
get
Get all VPS Snapshot Schedules for a Facility or VPS Instance
post
Create a VPS Snapshot Schedule
get
Get a VPS Snapshot Schedules
delete
Delete a VPS Snapshot Schedule
get
Get all VPS Instance Volumes available
post
Creates a new Volume
get
Get a VPS Instance Volume
put
Resize a Volume
delete
Deletes a Volume
get
Get a volume's list of upgradable sizes
get
Get VPS instance
put
Update VPS instance
post
Attach ISO to VPS instance
post
Create a one time use URL for console access to a VPS instance
post
Detach ISO from VPS instance
get
Get VPS Instance Events
get
Get Metrics for a VPS instance
post
Attach VPS Network to a VPS Device
delete
Detach a VPS Network from a VPS Device
put
Reset VPS root password, requires vps to be powered off
post
Request token to reset root password for VPS
get
Get all Secondary IP Addresses attached to VPS instance
post
Add a Secondary IP Address to VPS instance
delete
Remove a Secondary IP Address from VPS instance
post
Attach Volume to VPS instance
post
Detach Volume from VPS instance
Webhook
8
VPS
Create a one time use URL for console access to a VPS instance
post
/vps/{deviceId}/console
Headers
X-Fields
string
mask
An optional fields mask
Response
Success
VPSConsoleAccess
required
url
string
URL for console access