For AI agents: the docs index is at https://developers.hivelocity.net/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Hivelocity Developer PortalPricingDedicated ServersVPS
Product DocsRecipesAPI ReferenceChangelog
PricingDedicated ServersVPSSignupLog InHivelocity Developer Portal
API Reference
SignupLog In
Product DocsRecipesAPI ReferenceChangelog

Getting Started

  • Introduction

Hivelocity API

  • Account
    • Create controlled client for enterprise ownerpost
    • Deactivate clientput
    • Get all controlled clients for enterprise ownerget
  • Apps
    • /apps/get
    • Retrieve help text for a specific app after provisioningget
    • /apps/{appId}/validate-formpost
    • /apps/productsget
  • Backup
  • Bandwidth
    • Get data by devicepost
    • Get PNG by devicepost
    • Get data by servicepost
    • Get PNG by servicepost
  • Bare Metal Devices
    • Provision an instant devicepost
    • Get all devicesget
    • Batch provision instant devicespost
    • Update/reload instant deviceput
    • Cancel/delete devicedel
    • Get deviceget
  • Compute Devices
    • Provision an instant devicepost
    • Get all devicesget
    • Batch provision instant devicespost
    • Update/reload instant deviceput
    • Cancel/delete devicedel
    • Get deviceget
  • BillingInfo
    • Create verification for credit card with all Billing Infopost
    • Verify credit card with all Billing Infoput
    • Return a list with all Payment Methods (Billing Info)get
    • Add a new Bank Account as a Payment Methodpost
    • Update a Bank Accountput
    • Add a new Credit Card as a Payment Methodpost
    • Update a Credit Cardput
    • Return Payment Methods enabled for editingget
    • Delete a Payment Method by Billing Info IDdel
    • Return a Payment Method by Billing Info IDget
  • Cancellations
    • Create cancel requestpost
    • Get all cancel requestsget
    • Delete a Cancellationdel
    • Get cancel request by deviceget
    • Get all cancellation reasons for a Deviceget
    • Get cancel request by serviceget
  • Cloud
    • List the client's VDCsget
    • Get a single VDC with its allocation usageget
    • List the VDC's own ISOsget
    • Register an ISO from a URL (within the snapshot storagepost
    • Delete an ISOdel
    • Rename an ISO (the name the customer chose at register time);put
    • List the VDC's purchased and enforced (burst) limitsget
    • List the OS images deployable into the VDC's VMsget
    • List the snapshot schedules on the VDC's volumesget
    • Create a recurring snapshot schedule on a VDC volume; itspost
    • Delete a snapshot schedule (already-taken snapshots remain)del
    • List all snapshots of the VDC's volumesget
    • Snapshot a VDC volume (within the VDC's snapshot allocation)post
    • Delete a snapshotdel
    • Restore a snapshot onto its volume (the VM must be stopped)post
    • List the VDC's own templatesget
    • Create a template from a VDC snapshot (within the snapshotpost
    • Delete a templatedel
    • Rename a template (the name the customer chose at createput
    • List the VDC's VMsget
    • Deploy a custom-sized VM into the VDC (sized against itspost
    • Destroy + expunge a VMdel
    • Get a single VM's detailget
    • Rename a VM (its display name — applies while it runs);put
    • Request a one-time console URL for a VMpost
    • Detach the VM's attached ISOdel
    • Attach a VDC ISO to the VMput
    • Get a VM's root password (null until its first boot)get
    • Reload the VM's OS (wipes the root disk)post
    • Reset a stopped VM's root password (spawns a network task)post
    • Power a VM (start | stop | reboot)post
    • List the VDC's volumes, optionally filtered to one VMget
    • Create a data volume (within the VDC's volume and storagepost
    • Delete a detached data volume (synchronous; its snapshotsdel
    • Rename a volumeput
    • Attach the volume to a VMpost
    • Detach the volume from its VMpost
    • Grow the volume (within the storage allocation)post
  • Contact
    • Create a new Contactpost
    • Return a list with all Contactsget
    • Receive a request to reset password, and send a link by email with tokenpost
    • Receive a token and password, verify the user and reset your passwordput
    • Edit a Contactput
    • Delete a Contactdel
    • Return details of a specific Contactget
    • Change password for a Contactput
  • Credit
    • Receive billing method id and amount and return the created Creditpost
    • Return a list with all Creditsget
    • Apply the coupon code for a servicepost
    • Return the client's total active credit amountget
    • Validate the coupon code for a servicepost
  • Device
    • Get all devicesget
    • Bulk update IPMI thresholdsput
    • Get by payment methodget
    • Preview Ignition injectionspost
    • Get all tagsget
    • Update tag orderput
    • Get tag orderget
    • Get all tag ordersget
    • Update deviceput
    • Get deviceget
    • Get all eventsget
    • Get Ignition injectionsget
    • Get initial credsget
    • Get IPMI dataget
    • Get IPMI Java Consolepost
    • Get IPMI credsget
    • Clear IPMI whitelistget
    • Get IPMI noVNC Consolepost
    • Update IPMI thresholdsput
    • Get IPMI thresholdsget
    • Get IPMI access statusget
    • Whitelist IP for IPMIpost
    • Get IPsget
    • Clear all Port configurationspost
    • Update port networkput
    • Get portsget
    • Bond portspost
    • Unbond portsdel
    • Update power statuspost
    • Get power statusget
    • Reload devicepost
    • Get reload infoget
    • Get all device servicesget
    • Update device tagsput
    • Get device tagsget
    • Get reload info for all devicesget
    • Check if device's facility supports IPMI whitelist functionalityget
    • Get hardware summary (drives, RAM, RAID status)get
    • Get current provisioning status for a deviceget
  • Domains
    • Create a new domainpost
    • Return the domains of a clientget
    • Return the PTR records of a clientget
    • Update PTR recordput
    • Get PTR record by ID and nameget
    • Return the registered domains of a clientget
    • Create a new AAAA Record for given zonepost
    • Return all AAAA Records found for given zoneget
    • Update an AAAA Record for given idput
    • Delete an AAAA Record for given zonedel
    • Return Single AAAA Records found for given idget
    • Create a new MX Record for given zonepost
    • Return all MX Records found for given zoneget
    • Update an MX Record for given zoneput
    • Delete an MX Record for given zonedel
    • Return Single MX Records found for given idget
    • Delete domain for given iddel
    • Return a domain for given idget
    • Create a new A Record for given zonepost
    • Return all A Records found for given zone nameget
    • Update an A Record for given zoneput
    • Delete a single A Record value for given zonedel
    • Return Single A Records found for given domain nameget
  • Ignition
    • Creates a new Ignition configurationpost
    • Return all Ignition configurationsget
    • Update an Ignition configuration by IDput
    • Delete an Ignition configuration by IDdel
    • Return an Ignition configuration by IDget
  • Inventory
    • Get all facilitiesget
    • Get all productsget
    • Get productget
  • Invoice
    • Return serialized data on all invoicesget
    • Return results of invoice searchget
    • Return total balance of all unpaid invoicesget
    • Return serialized data on a single invoiceget
    • Apply account credit to an invoicepost
    • Return detailed information for an invoiceget
    • Return an Invoice PDF file in Base64 Encoded Formatget
    • /invoice/{invoiceId}/paypal/capturepost
    • /invoice/{invoiceId}/paypal/orderpost
  • IPAssignment
    • Request new assignmentpost
    • Get all assignmentsget
    • Get assignment by IPget
    • Combine assignmentspost
    • Route assignment to IPput
    • Delete assignmentdel
    • Get assignmentget
    • Clear all configuration on an IP Assignmentpost
    • Split assignmentpost
  • Maintenance
    • Get all Maintenance Events for a clientget
    • Get Maintenance Eventsget
  • Network
    • Get Cloud Interconnect Portsget
    • Get all ports by deviceget
    • Add a Null Route for an IP Addresspost
    • Return Null Routed IPsget
    • Remove Null Route for an IP Addressdel
    • Return record if IP Address is Null Routedget
    • Get network task statusget
    • Get network task status by Device ID or Task IDget
  • option
    • Get all Apps plan options grouped by option groupget
  • Order
    • Return a list with all Ordersget
    • Return a list of all In-Progress ordersget
    • Return details of a specific Orderget
    • /order/paypal/capture-multipost
    • /order/paypal/order-multipost
    • /order/{orderId}/paypal/capturepost
    • /order/{orderId}/paypal/orderpost
  • Order Groups
    • Create a new Order Grouppost
    • Return a list with all Order Groupsget
    • Update an Order Groupput
    • Delete the specified Order Groupdel
    • Return an Order Groupget
  • Permission
    • Endpoint to get All Permissionsget
    • Endpoint to assign a new Permission to a Contactpost
    • Endpoint to get Contact Permissionsget
    • Endpoint to get User Permissionsget
  • PrivateCloud
  • Product
    • Get all optionsget
    • Get product operating systemsget
    • Get product optionsget
  • Profile
    • Update Profile of current user or a contact with idput
    • Get Profile of current user or a contact with idget
    • Get Basic Profile of current user or a contact with idget
    • Update user passwordput
  • Deployment
    • Start a new deploymentpost
    • Return a list with all client deploymentsget
    • Receive product, quantity and options to be added on the deploymentput
    • Delete the specified deploymentdel
    • Return a dictionary with deployment informationget
    • Input a billing info id and script to process and finish a deploymentpost
  • RapidRestore
    • /rapid-restore/{deviceId}/device-statusget
  • SAML
    • Get current client's configuration for authentication with external Identity Providersget
    • Delete configuration for authentication with external Identity Providersdel
    • Configure authentication with external Identity Providerspost
  • Service
    • Return a list of all account servicesget
    • Return a dictionary with managed services operating system and panel requirementsget
    • Return all available service typesget
    • Return a dictionary with data from a specific account serviceget
    • Apply the coupon code for a servicepost
    • Return a dictionary with data verifying managed services eligibilityget
    • Validate the coupon code for a servicepost
  • SshKey
    • Adds public ssh keypost
    • Gets all public ssh keysget
    • Updates public ssh keyput
    • Removes public ssh keydel
    • Get public ssh keyget
  • Token
    • Updates the Public API Token with apiTokenIdput
    • Deletes the Public API Token with apiTokenIddel
    • 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 userpost
  • VPS
    • Get available upgrade options for a VPS productget
    • Get available upgrade options for a VPS productget
  • VLAN
    • Create VLANpost
    • Get all VLANsget
    • Modify VLANput
    • Delete VLANdel
    • Get VLANget
    • Clear all configurations on this VLAN, including Ports, IPs and associated Static Routespost
  • VPS
    • Get all VPS instancesget
    • Gets list of available sizes for new volumesget
    • Create a new ISOpost
    • Get all VPS ISOs availableget
    • Delete an ISOdel
    • Get the details of the VPS ISO ID specifiedget
    • Create a new VPS Networkpost
    • Get all VPS Networksget
    • Update VPS Networkput
    • Delete VPS Networkdel
    • Get VPS Networkget
    • Create a VPS Volume Snapshotpost
    • Get all VPS Volume Snapshots availableget
    • Restore a VPS Volume Snapshotpost
    • Delete a VPS Volume Snapshotdel
    • Get a VPS Volume Snapshot by IDget
    • Create a VPS Snapshot Schedulepost
    • Get all VPS Snapshot Schedules for a Facility or VPS Instanceget
    • Delete a VPS Snapshot Scheduledel
    • Get a VPS Snapshot Schedulesget
    • Creates a new Volumepost
    • Get all VPS Instance Volumes availableget
    • Resize a Volumeput
    • Deletes a Volumedel
    • Get a VPS Instance Volumeget
    • Get a volume's list of upgradable sizesget
    • Update VPS instanceput
    • Get VPS instanceget
    • Attach ISO to VPS instancepost
    • Create a one time use URL for console access to a VPS instancepost
    • Detach ISO from VPS instancepost
    • Get VPS Instance Eventsget
    • Get Metrics for a VPS instanceget
    • Attach VPS Network to a VPS Devicepost
    • Detach a VPS Network from a VPS Devicedel
    • Request token to reset root password for VPSpost
    • Reset VPS root password, requires vps to be powered offput
    • Add a Secondary IP Address to VPS instancepost
    • Get all Secondary IP Addresses attached to VPS instanceget
    • Remove a Secondary IP Address from VPS instancedel
    • Attach Volume to VPS instancepost
    • Detach Volume from VPS instancepost
  • Webhook
    • Create a new Webhook for a Webhook Eventpost
    • Returns your active Webhooksget
    • Returns all available Webhook Eventsget
    • Queues a webhook for the event script action that was triggeredpost
    • Updates a Single Webhookput
    • Deletes a single webhookdel
    • Returns detailed information for a Single Webhookget
    • /webhooks/etlpost
Powered by 

PrivateCloud

Endpoints to manage Hivelocity Private/Enterprise Cloud resources

Updated 9 days ago


Endpoint to get User Permissions
Product
Did this page help you?

Updated 9 days ago


Endpoint to get User Permissions
Product
Did this page help you?