Jump to Content
Pricing
Dedicated Servers
VPS
Product Docs
Recipes
API Reference
Changelog
Pricing
Dedicated Servers
VPS
Signup
Log In
API Reference
Search
Signup
Log In
Product Docs
Recipes
API Reference
Changelog
Deployment
All
Pages
Start typing to search…
JUMP TO
Getting Started
Introduction
Hivelocity API
Account
Create controlled client for enterprise owner
post
Deactivate client
put
Get all controlled clients for enterprise owner
get
Apps
/apps/
get
Retrieve help text for a specific app after provisioning
get
/apps/{appId}/validate-form
post
Backup
Get Veeam status
get
Bandwidth
Get data by device
post
Get PNG by device
post
Get data by service
post
Get PNG by service
post
Bare Metal Devices
Provision an instant device
post
Get all devices
get
Batch provision instant devices
post
Update/reload instant device
put
Cancel/delete device
del
Get device
get
Compute Devices
Provision an instant device
post
Get all devices
get
Batch provision instant devices
post
Update/reload instant device
put
Cancel/delete device
del
Get device
get
BillingInfo
Create verification for credit card with all Billing Info
post
Verify credit card with all Billing Info
put
Return a list with all Payment Methods (Billing Info)
get
Add a new Bank Account as a Payment Method
post
Update a Bank Account
put
Add a new Credit Card as a Payment Method
post
Update a Credit Card
put
Return Payment Methods enabled for editing
get
Delete a Payment Method by Billing Info ID
del
Return a Payment Method by Billing Info ID
get
Cancellations
Create cancel request
post
Get all cancel requests
get
Delete a Cancellation
del
Get cancel request by device
get
Get all cancellation reasons for a Device
get
Get cancel request by service
get
Contact
Create a new Contact
post
Return a list with all Contacts
get
Receive a request to reset password, and send a link by email with token
post
Receive a token and password, verify the user and reset your password
put
Edit a Contact
put
Delete a Contact
del
Return details of a specific Contact
get
Change password for a Contact
put
Credit
Receive billing method id and amount and return the created Credit
post
Return a list with all Credits
get
Apply the coupon code for a service
post
Return the client's total active credit amount
get
Validate the coupon code for a service
post
Device
Get all devices
get
Bulk update IPMI thresholds
put
Get by payment method
get
Preview Ignition injections
post
Get all tags
get
Update tag order
put
Get tag order
get
Get all tag orders
get
Update device
put
Get device
get
Get all events
get
Get Ignition injections
get
Get initial creds
get
Get initial password
get
Get IPMI data
get
Get IPMI Java Console
post
Get IPMI creds
get
Clear IPMI whitelist
get
Get IPMI noVNC Console
post
Update IPMI thresholds
put
Get IPMI thresholds
get
Get IPMI access status
get
Whitelist IP for IPMI
post
Get IPs
get
Clear all Port configurations
post
Update port network
put
Get ports
get
Bond ports
post
Unbond ports
del
Update power status
post
Get power status
get
Reload device
post
Get reload info
get
Get all device services
get
Update device tags
put
Get device tags
get
Domains
Create a new domain
post
Return the domains of a client
get
Return the PTR records of a client
get
Update PTR record
put
Get PTR record by ID and name
get
Return the registered domains of a client
get
Create a new AAAA Record for given zone
post
Return all AAAA Records found for given zone
get
Update an AAAA Record for given id
put
Delete an AAAA Record for given zone
del
Return Single AAAA Records found for given id
get
Create a new MX Record for given zone
post
Return all MX Records found for given zone
get
Update an MX Record for given zone
put
Delete an MX Record for given zone
del
Return Single MX Records found for given id
get
Delete domain for given id
del
Return a domain for given id
get
Create a new A Record for given zone
post
Return all A Records found for given zone name
get
Update an A Record for given zone
put
Delete a single A Record value for given zone
del
Return Single A Records found for given domain name
get
Ignition
Creates a new Ignition configuration
post
Return all Ignition configurations
get
Update an Ignition configuration by ID
put
Delete an Ignition configuration by ID
del
Return an Ignition configuration by ID
get
Inventory
Get all facilities
get
Get all products
get
Get product
get
Invoice
Return serialized data on all invoices
get
Return results of invoice search
get
Return total balance of all unpaid invoices
get
Return serialized data on a single invoice
get
Apply account credit to an invoice
post
Return detailed information for an invoice
get
Return an Invoice PDF file in Base64 Encoded Format
get
IPAssignment
Request new assignment
post
Get all assignments
get
Get assignment by IP
get
Combine assignments
post
Route assignment to IP
put
Delete assignment
del
Get assignment
get
Clear all configuration on an IP Assignment
post
Split assignment
post
Maintenance
Get all Maintenance Events for a client
get
Get Maintenance Events
get
Network
Get Cloud Interconnect Ports
get
Get all ports by device
get
Add a Null Route for an IP Address
post
Return Null Routed IPs
get
Remove Null Route for an IP Address
del
Return record if IP Address is Null Routed
get
Get network task status
get
Get network task status by Device ID or Task ID
get
option
Get all Apps plan options grouped by option group
get
Order
Return a list with all Orders
get
Return a list of all In-Progress orders
get
Return details of a specific Order
get
Order Groups
Create a new Order Group
post
Return a list with all Order Groups
get
Update an Order Group
put
Delete the specified Order Group
del
Return an Order Group
get
Permission
Endpoint to get All Permissions
get
Endpoint to assign a new Permission to a Contact
post
Endpoint to get Contact Permissions
get
Endpoint to get User Permissions
get
PrivateCloud
/private-cloud/config/saml
post
Product
Get all options
get
Get product operating systems
get
Get product options
get
Profile
Update Profile of current user or a contact with id
put
Get Profile of current user or a contact with id
get
Get Basic Profile of current user or a contact with id
get
Update user password
put
Deployment
Start a new deployment
post
Return a list with all client deployments
get
Receive product, quantity and options to be added on the deployment
put
Delete the specified deployment
del
Return a dictionary with deployment information
get
Input a billing info id and script to process and finish a deployment
post
RapidRestore
/rapid-restore/{deviceId}/device-status
get
Service
Return a list of all account services
get
Return a dictionary with managed services operating system and panel requirements
get
Return all available service types
get
Return a dictionary with data from a specific account service
get
Apply the coupon code for a service
post
Return a dictionary with data verifying managed services eligibility
get
Validate the coupon code for a service
post
SshKey
Adds public ssh key
post
Gets all public ssh keys
get
Updates public ssh key
put
Removes public ssh key
del
Get public ssh key
get
Ticket
Creates a new ticket
post
Returns a list with all Tickets
get
Return results of ticket search
get
Updates a specific ticket
put
Returns details of a specific ticket
get
Creates reply for a specific Ticket
post
Returns a reply for a specific ticket
get
Token
Updates the Public API Token with apiTokenId
put
Deletes the Public API Token with apiTokenId
del
Returns a list of Public API Tokens for the current user (last 4 characters only)
get
Create a new Public API Token for the current user
post
VLAN
Create VLAN
post
Get all VLANs
get
Modify VLAN
put
Delete VLAN
del
Get VLAN
get
Clear all configurations on this VLAN, including Ports, IPs and associated Static Routes
post
VPS
Get all VPS instances
get
Gets list of available sizes for new volumes
get
Create a new ISO
post
Get all VPS ISOs available
get
Delete an ISO
del
Get the details of the VPS ISO ID specified
get
Create a new VPS Network
post
Get all VPS Networks
get
Update VPS Network
put
Delete VPS Network
del
Get VPS Network
get
Create a VPS Volume Snapshot
post
Get all VPS Volume Snapshots available
get
Restore a VPS Volume Snapshot
post
Delete a VPS Volume Snapshot
del
Get a VPS Volume Snapshot by ID
get
Create a VPS Snapshot Schedule
post
Get all VPS Snapshot Schedules for a Facility or VPS Instance
get
Delete a VPS Snapshot Schedule
del
Get a VPS Snapshot Schedules
get
Creates a new Volume
post
Get all VPS Instance Volumes available
get
Resize a Volume
put
Deletes a Volume
del
Get a VPS Instance Volume
get
Get a volume's list of upgradable sizes
get
Update VPS instance
put
Get VPS instance
get
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
post
Get VPS Instance Events
get
Get Metrics for a VPS instance
get
Attach VPS Network to a VPS Device
post
Detach a VPS Network from a VPS Device
del
Request token to reset root password for VPS
post
Reset VPS root password, requires vps to be powered off
put
Add a Secondary IP Address to VPS instance
post
Get all Secondary IP Addresses attached to VPS instance
get
Remove a Secondary IP Address from VPS instance
del
Attach Volume to VPS instance
post
Detach Volume from VPS instance
post
Webhook
Create a new Webhook for a Webhook Event
post
Returns your active Webhooks
get
Returns all available Webhook Events
get
Queues a webhook for the event script action that was triggered
post
Updates a Single Webhook
put
Deletes a single webhook
del
Returns detailed information for a Single Webhook
get
Powered by
Deployment
Ask AI
This endpoint is used to handle product deployment actions.
