# Hivelocity Developer Portal Documentation

> Hivelocity developer portal and API reference for bare metal cloud dedicated servers.

## Product Docs: Getting Started
- [Developer Portal](https://developers.hivelocity.net/docs/getting-started.md)
  - [Deploy a Server via API](https://developers.hivelocity.net/docs/deploy-a-server-via-api.md)

## Product Docs: Product Docs
- [Accounts](https://developers.hivelocity.net/docs/accounts.md)
  - [Account (Client)](https://developers.hivelocity.net/docs/client-account.md)
  - [Sub-Accounts (Contacts)](https://developers.hivelocity.net/docs/contacts.md)
  - [SSH Keys](https://developers.hivelocity.net/docs/ssh-keys.md)
  - [API Keys](https://developers.hivelocity.net/docs/api-keys.md)
  - [Account Security](https://developers.hivelocity.net/docs/account-security.md)
  - [Billing](https://developers.hivelocity.net/docs/billing.md)
  - [SAML 2.0 Setup for Okta](https://developers.hivelocity.net/docs/saml-20-setup-for-okta.md): Hivelocity (myVelocity and the E-Commerce Store) can authenticate users with an IDP (Identity Provider) that supports the SAML 2.0 protocol.  This document will guide you through configuring your…
- [Facilities](https://developers.hivelocity.net/docs/facilities.md)
- [Instant](https://developers.hivelocity.net/docs/instant.md)
- [Virtual Server Products](https://developers.hivelocity.net/docs/vps.md): Hivelocity Virtual Servers
  - [Virtual Server Management](https://developers.hivelocity.net/docs/vps-device-management.md): The routes in this page handle Virtual server updates as well as access to the Virtual server console and Event viewer.
  - [Virtual Server ISO and Volume Operations](https://developers.hivelocity.net/docs/vps-iso-and-volume-operations.md): Hivelocity Virtual server endpoint details
  - [Virtual Server Snapshots](https://developers.hivelocity.net/docs/vps-snapshots.md): Details on the Virtual server endpoint dealing with Snapshots
  - [Virtual Server FAQ](https://developers.hivelocity.net/docs/vps-faq.md): Frequently asked questions for the Hivelocity Virtual server products
- [Operating Systems](https://developers.hivelocity.net/docs/operating-systems.md)
  - [Custom iPXE](https://developers.hivelocity.net/docs/custom-ipxe.md)
- [IPs and Subnets](https://developers.hivelocity.net/docs/ips-and-subnets.md)
- [Apps](https://developers.hivelocity.net/docs/apps-1.md)
- [Terraform Import (For existing Devices)](https://developers.hivelocity.net/docs/terraform.md)
- [Bug Bounty Program](https://developers.hivelocity.net/docs/bug-bounty-program.md)
- [Resellers And Solution Partners](https://developers.hivelocity.net/docs/resellers-and-solution-partners.md)

## Product Docs: Reseller Docs
- [API Rate Limiting](https://developers.hivelocity.net/docs/api-rate-limiting.md)

## API Reference: Hivelocity API
- [Account](https://developers.hivelocity.net/reference/account.md): Account controls for Enterprise Owner type clients
  - [Create controlled client for enterprise owner](https://developers.hivelocity.net/reference/post_account_create.md)
  - [Deactivate client](https://developers.hivelocity.net/reference/put_account_create.md)
  - [Get all controlled clients for enterprise owner](https://developers.hivelocity.net/reference/get_account_create.md)
- Apps
  - [/apps/](https://developers.hivelocity.net/reference/get_public_apps_resource.md)
  - [Retrieve help text for a specific app after provisioning](https://developers.hivelocity.net/reference/get_public_app_help_resource.md): This is in markdown format.
  - [/apps/{appId}/validate-form](https://developers.hivelocity.net/reference/post_public_app_form_validate.md)
  - [/apps/products](https://developers.hivelocity.net/reference/get_public_app_products_resource.md)
- Backup
  - [Get Veeam status](https://developers.hivelocity.net/reference/get_private_cloud_veeam_restore_point_resource.md)
- [Bandwidth](https://developers.hivelocity.net/reference/bandwidth.md): Builds graphs to show bandwidth data over time per device or service.
  - [Get data by device](https://developers.hivelocity.net/reference/post_device_id_bandwidth_resource.md)
  - [Get PNG by device](https://developers.hivelocity.net/reference/post_device_id_bandwidth_image_resource.md)
  - [Get data by service](https://developers.hivelocity.net/reference/post_service_id_bandwidth_resource.md)
  - [Get PNG by service](https://developers.hivelocity.net/reference/post_service_id_bandwidth_image_resource.md)
- [Bare Metal Devices](https://developers.hivelocity.net/reference/bare-metal-devices.md): Bare Metal server endpoint for getting details, provisioning and cancelling.
  - [Provision an instant device](https://developers.hivelocity.net/reference/post_bare_metal_device_resource.md)
  - [Get all devices](https://developers.hivelocity.net/reference/get_bare_metal_device_resource.md)
  - [Batch provision instant devices](https://developers.hivelocity.net/reference/post_bare_metal_device_batch_resource.md)
  - [Update/reload instant device](https://developers.hivelocity.net/reference/put_bare_metal_device_id_resource.md)
  - [Cancel/delete device](https://developers.hivelocity.net/reference/delete_bare_metal_device_id_resource.md)
  - [Get device](https://developers.hivelocity.net/reference/get_bare_metal_device_id_resource.md)
- Compute Devices
  - [Provision an instant device](https://developers.hivelocity.net/reference/post_compute_resource.md)
  - [Get all devices](https://developers.hivelocity.net/reference/get_compute_resource.md)
  - [Batch provision instant devices](https://developers.hivelocity.net/reference/post_compute_batch_resource.md)
  - [Update/reload instant device](https://developers.hivelocity.net/reference/put_compute_id_resource.md)
  - [Cancel/delete device](https://developers.hivelocity.net/reference/delete_compute_id_resource.md)
  - [Get device](https://developers.hivelocity.net/reference/get_compute_id_resource.md)
- [BillingInfo](https://developers.hivelocity.net/reference/billinginfo.md): Hivelocity endpoint used in creating credit card verification
  - [Create verification for credit card with all Billing Info](https://developers.hivelocity.net/reference/post_billing_info_resource.md)
  - [Verify credit card with all Billing Info](https://developers.hivelocity.net/reference/put_billing_info_resource.md)
  - [Return a list with all Payment Methods (Billing Info)](https://developers.hivelocity.net/reference/get_billing_info_resource.md)
  - [Add a new Bank Account as a Payment Method](https://developers.hivelocity.net/reference/post_billing_info_bank_account_create_resource.md)
  - [Update a Bank Account](https://developers.hivelocity.net/reference/put_billing_info_bank_account_update_resource.md)
  - [Add a new Credit Card as a Payment Method](https://developers.hivelocity.net/reference/post_billing_info_credit_card_create_resource.md)
  - [Update a Credit Card](https://developers.hivelocity.net/reference/put_billing_info_credit_card_update_resource.md)
  - [Return Payment Methods enabled for editing](https://developers.hivelocity.net/reference/get_payment_methods_enable_read_resource.md)
  - [Delete a Payment Method by Billing Info ID](https://developers.hivelocity.net/reference/delete_billing_info_id_resource.md)
  - [Return a Payment Method by Billing Info ID](https://developers.hivelocity.net/reference/get_billing_info_id_resource.md)
- [Cancellations](https://developers.hivelocity.net/reference/cancellations.md): This endpoint handles all cancellation requests for devices and services.
  - [Create cancel request](https://developers.hivelocity.net/reference/post_cancellation_resource.md)
  - [Get all cancel requests](https://developers.hivelocity.net/reference/get_cancellation_resource.md)
  - [Delete a Cancellation](https://developers.hivelocity.net/reference/delete_cancellation_id_delete_resource.md)
  - [Get cancel request by device](https://developers.hivelocity.net/reference/get_cancellation_device_resource.md)
  - [Get all cancellation reasons for a Device](https://developers.hivelocity.net/reference/get_cancellation_reason_device_id_resource.md)
  - [Get cancel request by service](https://developers.hivelocity.net/reference/get_cancellation_service_resource.md)
- Cloud
  - [List the client's VDCs](https://developers.hivelocity.net/reference/get_cloud_vdcs_resource.md)
  - [Get a single VDC with its allocation usage](https://developers.hivelocity.net/reference/get_cloud_vdc_resource.md)
  - [List the VDC's own ISOs](https://developers.hivelocity.net/reference/get_cloud_vdc_isos_resource.md)
  - [Register an ISO from a URL (within the snapshot storage](https://developers.hivelocity.net/reference/post_cloud_vdc_isos_resource.md): allocation). CloudStack downloads it in the background — the ISO lists as not ready until the download finishes.
  - [Delete an ISO](https://developers.hivelocity.net/reference/delete_cloud_vdc_iso_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [Rename an ISO (the name the customer chose at register time);](https://developers.hivelocity.net/reference/put_cloud_vdc_iso_resource.md): returns the updated ISO
  - [List the VDC's purchased and enforced (burst) limits](https://developers.hivelocity.net/reference/get_cloud_vdc_limits_resource.md)
  - [List the OS images deployable into the VDC's VMs](https://developers.hivelocity.net/reference/get_cloud_vdc_os_options_resource.md)
  - [List the snapshot schedules on the VDC's volumes](https://developers.hivelocity.net/reference/get_cloud_vdc_snapshot_schedules_resource.md)
  - [Create a recurring snapshot schedule on a VDC volume; its](https://developers.hivelocity.net/reference/post_cloud_vdc_snapshot_schedules_resource.md): retention (maxSnapshots) counts against the VDC's snapshot allocation
  - [Delete a snapshot schedule (already-taken snapshots remain)](https://developers.hivelocity.net/reference/delete_cloud_vdc_snapshot_schedule_resource.md)
  - [List all snapshots of the VDC's volumes](https://developers.hivelocity.net/reference/get_cloud_vdc_snapshots_resource.md)
  - [Snapshot a VDC volume (within the VDC's snapshot allocation)](https://developers.hivelocity.net/reference/post_cloud_vdc_snapshots_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [Delete a snapshot](https://developers.hivelocity.net/reference/delete_cloud_vdc_snapshot_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [Restore a snapshot onto its volume (the VM must be stopped)](https://developers.hivelocity.net/reference/post_cloud_vdc_snapshot_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [List the VDC's own templates](https://developers.hivelocity.net/reference/get_cloud_vdc_templates_resource.md)
  - [Create a template from a VDC snapshot (within the snapshot](https://developers.hivelocity.net/reference/post_cloud_vdc_templates_resource.md): storage allocation). Spawns a standard network task — poll it via the network-task endpoints.
  - [Delete a template](https://developers.hivelocity.net/reference/delete_cloud_vdc_template_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [Rename a template (the name the customer chose at create](https://developers.hivelocity.net/reference/put_cloud_vdc_template_resource.md): time); returns the updated template
  - [List the VDC's VMs](https://developers.hivelocity.net/reference/get_cloud_vdc_vms_resource.md)
  - [Deploy a custom-sized VM into the VDC (sized against its](https://developers.hivelocity.net/reference/post_cloud_vdc_vms_resource.md): allocation; pool public IP). Spawns a standard network task that runs the whole deploy — poll it via the network-task endpoints.
  - [Destroy + expunge a VM](https://developers.hivelocity.net/reference/delete_cloud_vdc_vm_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [Get a single VM's detail](https://developers.hivelocity.net/reference/get_cloud_vdc_vm_resource.md)
  - [Rename a VM (its display name — applies while it runs);](https://developers.hivelocity.net/reference/put_cloud_vdc_vm_resource.md): returns the updated VM
  - [Request a one-time console URL for a VM](https://developers.hivelocity.net/reference/post_cloud_vdc_vm_console_resource.md)
  - [Detach the VM's attached ISO](https://developers.hivelocity.net/reference/delete_cloud_vdc_vm_iso_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [Attach a VDC ISO to the VM](https://developers.hivelocity.net/reference/put_cloud_vdc_vm_iso_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [Get a VM's root password (null until its first boot)](https://developers.hivelocity.net/reference/get_cloud_vdc_vm_password_resource.md)
  - [Reload the VM's OS (wipes the root disk)](https://developers.hivelocity.net/reference/post_cloud_vdc_vm_reload_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [Reset a stopped VM's root password (spawns a network task)](https://developers.hivelocity.net/reference/post_cloud_vdc_vm_password_reset_resource.md)
  - [Power a VM (start | stop | reboot)](https://developers.hivelocity.net/reference/post_cloud_vdc_vm_power_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [List the VDC's volumes, optionally filtered to one VM](https://developers.hivelocity.net/reference/get_cloud_vdc_volumes_resource.md)
  - [Create a data volume (within the VDC's volume and storage](https://developers.hivelocity.net/reference/post_cloud_vdc_volumes_resource.md): allocation). Spawns a standard network task — poll it via the network-task endpoints.
  - [Delete a detached data volume (synchronous; its snapshots](https://developers.hivelocity.net/reference/delete_cloud_vdc_volume_resource.md): survive on secondary storage)
  - [Rename a volume](https://developers.hivelocity.net/reference/put_cloud_vdc_volume_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [Attach the volume to a VM](https://developers.hivelocity.net/reference/post_cloud_vdc_volume_attach_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [Detach the volume from its VM](https://developers.hivelocity.net/reference/post_cloud_vdc_volume_detach_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
  - [Grow the volume (within the storage allocation)](https://developers.hivelocity.net/reference/post_cloud_vdc_volume_resize_resource.md): Spawns a standard network task — poll it via the network-task endpoints.
- [Contact](https://developers.hivelocity.net/reference/contact.md): This endpoint handles contact operations including creation, deletion, edit, password management and returning contact details.
  - [Create a new Contact](https://developers.hivelocity.net/reference/post_contact_resource.md)
  - [Return a list with all Contacts](https://developers.hivelocity.net/reference/get_contact_resource.md)
  - [Receive a request to reset password, and send a link by email with token](https://developers.hivelocity.net/reference/post_password_reset.md)
  - [Receive a token and password, verify the user and reset your password](https://developers.hivelocity.net/reference/put_password_reset.md)
  - [Edit a Contact](https://developers.hivelocity.net/reference/put_contact_id_resource.md)
  - [Delete a Contact](https://developers.hivelocity.net/reference/delete_contact_id_resource.md)
  - [Return details of a specific Contact](https://developers.hivelocity.net/reference/get_contact_id_resource.md)
  - [Change password for a Contact](https://developers.hivelocity.net/reference/put_password_resource.md)
- [Credit](https://developers.hivelocity.net/reference/credit.md): This endpoint handles the creation and review of credits applied to a client's account to be used for future billing.
  - [Receive billing method id and amount and return the created Credit](https://developers.hivelocity.net/reference/post_credit_resource.md)
  - [Return a list with all Credits](https://developers.hivelocity.net/reference/get_credit_resource.md)
  - [Apply the coupon code for a service](https://developers.hivelocity.net/reference/post_credit_apply_coupon_resource.md)
  - [Return the client's total active credit amount](https://developers.hivelocity.net/reference/get_total_active_credit_resource.md)
  - [Validate the coupon code for a service](https://developers.hivelocity.net/reference/post_credit_validate_coupon_resource.md)
- Device
  - [Get all devices](https://developers.hivelocity.net/reference/get_device_resource.md)
  - [Bulk update IPMI thresholds](https://developers.hivelocity.net/reference/put_ipmi_devices_thresholds_id_resource.md)
  - [Get by payment method](https://developers.hivelocity.net/reference/get_device_payment_method_linked_resource.md)
  - [Preview Ignition injections](https://developers.hivelocity.net/reference/post_preview_effective_ignition_resource.md)
  - [Get all tags](https://developers.hivelocity.net/reference/get_client_device_tag_resource.md)
  - [Update tag order](https://developers.hivelocity.net/reference/put_client_device_tag_order_resource.md)
  - [Get tag order](https://developers.hivelocity.net/reference/get_client_device_tag_order_resource.md)
  - [Get all tag orders](https://developers.hivelocity.net/reference/get_all_device_tag_order_resource.md)
  - [Update device](https://developers.hivelocity.net/reference/put_device_id_resource.md)
  - [Get device](https://developers.hivelocity.net/reference/get_device_id_resource.md)
  - [Get all events](https://developers.hivelocity.net/reference/get_device_id_event_resource.md)
  - [Get Ignition injections](https://developers.hivelocity.net/reference/get_effective_ignition_id_resource.md)
  - [Get initial creds](https://developers.hivelocity.net/reference/get_initial_creds_id_resource.md)
  - [Get IPMI data](https://developers.hivelocity.net/reference/get_ipmi_info_id_resource.md)
  - [Get IPMI Java Console](https://developers.hivelocity.net/reference/post_ipmi_java_console_id_resource.md)
  - [Get IPMI creds](https://developers.hivelocity.net/reference/get_ipmi_info_login_data_resource.md)
  - [Clear IPMI whitelist](https://developers.hivelocity.net/reference/get_device_ipminat_rule_resource.md)
  - [Get IPMI noVNC Console](https://developers.hivelocity.net/reference/post_ipmi_no_vnc_console_id_resource.md)
  - [Update IPMI thresholds](https://developers.hivelocity.net/reference/put_ipmi_thresholds_id_resource.md)
  - [Get IPMI thresholds](https://developers.hivelocity.net/reference/get_ipmi_thresholds_id_resource.md)
  - [Get IPMI access status](https://developers.hivelocity.net/reference/get_ipmi_valid_login_id_resource.md)
  - [Whitelist IP for IPMI](https://developers.hivelocity.net/reference/post_device_ipmi_whitelist_resource.md)
  - [Get IPs](https://developers.hivelocity.net/reference/get_device_ip_assignments_resource.md)
  - [Clear all Port configurations](https://developers.hivelocity.net/reference/post_device_port_id_clear_resource-1.md)
  - [Update port network](https://developers.hivelocity.net/reference/put_device_port_resource-9.md)
  - [Get ports](https://developers.hivelocity.net/reference/get_device_port_resource.md)
  - [Bond ports](https://developers.hivelocity.net/reference/post_device_bond_resource.md)
  - [Unbond ports](https://developers.hivelocity.net/reference/delete_device_bond_resource.md)
  - [Update power status](https://developers.hivelocity.net/reference/post_power_resource.md)
  - [Get power status](https://developers.hivelocity.net/reference/get_power_resource.md)
  - [Reload device](https://developers.hivelocity.net/reference/post_device_reload_resource.md)
  - [Get reload info](https://developers.hivelocity.net/reference/get_device_reload_resource.md)
  - [Get all device services](https://developers.hivelocity.net/reference/get_device_id_service_resource.md)
  - [Update device tags](https://developers.hivelocity.net/reference/put_device_tag_id_resource.md)
  - [Get device tags](https://developers.hivelocity.net/reference/get_device_tag_id_resource.md)
  - [Get reload info for all devices](https://developers.hivelocity.net/reference/get_devices_reload_resource.md)
  - [Check if device's facility supports IPMI whitelist functionality](https://developers.hivelocity.net/reference/get_device_ipmi_whitelist_supported_resource.md)
  - [Get hardware summary (drives, RAM, RAID status)](https://developers.hivelocity.net/reference/get_device_hardware_resource.md)
  - [Get current provisioning status for a device](https://developers.hivelocity.net/reference/get_customer_device_provision_status_resource.md)
- Domains
  - [Create a new domain](https://developers.hivelocity.net/reference/post_domain_resource.md)
  - [Return the domains of a client](https://developers.hivelocity.net/reference/get_domain_resource.md)
  - [Return the PTR records of a client](https://developers.hivelocity.net/reference/get_ptr_record_resource.md)
  - [Update PTR record](https://developers.hivelocity.net/reference/put_ptr_record_id_resource.md)
  - [Get PTR record by ID and name](https://developers.hivelocity.net/reference/get_ptr_record_id_resource.md)
  - [Return the registered domains of a client](https://developers.hivelocity.net/reference/get_registered_domain_resource.md)
  - [Create a new AAAA Record for given zone](https://developers.hivelocity.net/reference/post_aaaa_record_resource.md)
  - [Return all AAAA Records found for given zone](https://developers.hivelocity.net/reference/get_aaaa_record_resource.md)
  - [Update an AAAA Record for given id](https://developers.hivelocity.net/reference/put_aaaa_record_id_resource.md)
  - [Delete an AAAA Record for given zone](https://developers.hivelocity.net/reference/delete_aaaa_record_id_resource.md)
  - [Return Single AAAA Records found for given id](https://developers.hivelocity.net/reference/get_aaaa_record_id_resource.md)
  - [Create a new MX Record for given zone](https://developers.hivelocity.net/reference/post_mx_record_resource.md)
  - [Return all MX Records found for given zone](https://developers.hivelocity.net/reference/get_mx_record_resource.md)
  - [Update an MX Record for given zone](https://developers.hivelocity.net/reference/put_mx_record_id_resource.md)
  - [Delete an MX Record for given zone](https://developers.hivelocity.net/reference/delete_mx_record_id_resource.md)
  - [Return Single MX Records found for given id](https://developers.hivelocity.net/reference/get_mx_record_id_resource.md)
  - [Delete domain for given id](https://developers.hivelocity.net/reference/delete_domain_id_resource.md)
  - [Return a domain for given id](https://developers.hivelocity.net/reference/get_domain_id_resource.md)
  - [Create a new A Record for given zone](https://developers.hivelocity.net/reference/post_a_record_resource.md)
  - [Return all A Records found for given zone name](https://developers.hivelocity.net/reference/get_a_record_resource.md)
  - [Update an A Record for given zone](https://developers.hivelocity.net/reference/put_a_record_id_resource.md)
  - [Delete a single A Record value for given zone](https://developers.hivelocity.net/reference/delete_a_record_id_resource.md)
  - [Return Single A Records found for given domain name](https://developers.hivelocity.net/reference/get_a_record_id_resource.md)
- Ignition
  - [Creates a new Ignition configuration](https://developers.hivelocity.net/reference/post_ignition_resource.md)
  - [Return all Ignition configurations](https://developers.hivelocity.net/reference/get_ignition_resource.md)
  - [Update an Ignition configuration by ID](https://developers.hivelocity.net/reference/put_ignition_resource_id.md)
  - [Delete an Ignition configuration by ID](https://developers.hivelocity.net/reference/delete_ignition_resource_id.md)
  - [Return an Ignition configuration by ID](https://developers.hivelocity.net/reference/get_ignition_resource_id.md)
- Inventory
  - [Get all facilities](https://developers.hivelocity.net/reference/get_location_resource.md)
  - [Get all products](https://developers.hivelocity.net/reference/get_stock_resource.md)
  - [Get product](https://developers.hivelocity.net/reference/get_stock_by_product_resource.md)
- Invoice
  - [Return serialized data on all invoices](https://developers.hivelocity.net/reference/get_invoice_resource.md)
  - [Return results of invoice search](https://developers.hivelocity.net/reference/get_invoice_search_resource.md)
  - [Return total balance of all unpaid invoices](https://developers.hivelocity.net/reference/get_invoice_unpaid_resource.md)
  - [Return serialized data on a single invoice](https://developers.hivelocity.net/reference/get_invoice_id_resource.md)
  - [Apply account credit to an invoice](https://developers.hivelocity.net/reference/post_invoice_id_apply_account_credit.md)
  - [Return detailed information for an invoice](https://developers.hivelocity.net/reference/get_invoice_id_details.md): Same data as the PDF file but serialized
  - [Return an Invoice PDF file in Base64 Encoded Format](https://developers.hivelocity.net/reference/get_invoice_pdf_resource.md)
  - [/invoice/{invoiceId}/paypal/capture](https://developers.hivelocity.net/reference/post_invoice_paypal_capture_resource.md)
  - [/invoice/{invoiceId}/paypal/order](https://developers.hivelocity.net/reference/post_invoice_paypal_order_resource.md)
- IPAssignment
  - [Request new assignment](https://developers.hivelocity.net/reference/post_ip_assignment_resource.md): This endpoint is used to request a new IP Assignment from MyV and the API itself.  It will create a request on Zendesk for Networking support team.
  - [Get all assignments](https://developers.hivelocity.net/reference/get_ip_assignment_resource.md)
  - [Get assignment by IP](https://developers.hivelocity.net/reference/get_ip_assignment_subnet_resource.md)
  - [Combine assignments](https://developers.hivelocity.net/reference/post_ip_assignment_combine_resource.md)
  - [Route assignment to IP](https://developers.hivelocity.net/reference/put_ip_assignment_id_resource.md)
  - [Delete assignment](https://developers.hivelocity.net/reference/delete_ip_assignment_id_resource.md)
  - [Get assignment](https://developers.hivelocity.net/reference/get_ip_assignment_id_resource.md)
  - [Clear all configuration on an IP Assignment](https://developers.hivelocity.net/reference/post_ip_assignment_id_clear_resource-1.md)
  - [Split assignment](https://developers.hivelocity.net/reference/post_ip_assignment_split_resource.md)
- Maintenance
  - [Get all Maintenance Events for a client](https://developers.hivelocity.net/reference/get_maintenance_event_client_resource.md)
  - [Get Maintenance Events](https://developers.hivelocity.net/reference/get_maintenance_event_id_client_resource.md)
- Network
  - [Get Cloud Interconnect Ports](https://developers.hivelocity.net/reference/get_cloud_interconnect_resource.md)
  - [Get all ports by device](https://developers.hivelocity.net/reference/get_device_network_port_resource.md)
  - [Add a Null Route for an IP Address](https://developers.hivelocity.net/reference/post_null_routes_resource.md)
  - [Return Null Routed IPs](https://developers.hivelocity.net/reference/get_null_routes_resource.md)
  - [Remove Null Route for an IP Address](https://developers.hivelocity.net/reference/delete_null_routes_id_resource.md)
  - [Return record if IP Address is Null Routed](https://developers.hivelocity.net/reference/get_null_routes_id_resource.md)
  - [Get network task status](https://developers.hivelocity.net/reference/get_network_task_client_resource.md)
  - [Get network task status by Device ID or Task ID](https://developers.hivelocity.net/reference/get_network_task_id_resource-1.md)
- option
  - [Get all Apps plan options grouped by option group](https://developers.hivelocity.net/reference/get_option_apps_resource.md)
- Order
  - [Return a list with all Orders](https://developers.hivelocity.net/reference/get_order_resource.md)
  - [Return a list of all In-Progress orders](https://developers.hivelocity.net/reference/get_order_inprogress_resource.md)
  - [Return details of a specific Order](https://developers.hivelocity.net/reference/get_order_id_resource.md)
  - [/order/paypal/capture-multi](https://developers.hivelocity.net/reference/post_order_paypal_capture_multi_resource.md)
  - [/order/paypal/order-multi](https://developers.hivelocity.net/reference/post_order_paypal_order_multi_resource.md)
  - [/order/{orderId}/paypal/capture](https://developers.hivelocity.net/reference/post_order_paypal_capture_resource.md)
  - [/order/{orderId}/paypal/order](https://developers.hivelocity.net/reference/post_order_paypal_order_resource.md)
- Order Groups
  - [Create a new Order Group](https://developers.hivelocity.net/reference/post_order_group_resource.md)
  - [Return a list with all Order Groups](https://developers.hivelocity.net/reference/get_order_group_resource.md)
  - [Update an Order Group](https://developers.hivelocity.net/reference/put_order_group_id_resource.md)
  - [Delete the specified Order Group](https://developers.hivelocity.net/reference/delete_order_group_id_resource.md)
  - [Return an Order Group](https://developers.hivelocity.net/reference/get_order_group_id_resource.md)
- Permission
  - [Endpoint to get All Permissions](https://developers.hivelocity.net/reference/get_permission_all_resource.md)
  - [Endpoint to assign a new Permission to a Contact](https://developers.hivelocity.net/reference/post_permission_assign_contact_resource.md)
  - [Endpoint to get Contact Permissions](https://developers.hivelocity.net/reference/get_permission_contact_resource.md)
  - [Endpoint to get User Permissions](https://developers.hivelocity.net/reference/get_permission_user_resource.md)
- PrivateCloud
  - [/private-cloud/config/saml](https://developers.hivelocity.net/reference/post_private_cloud_saml_config_resource.md)
- Product
  - [Get all options](https://developers.hivelocity.net/reference/get_products_and_options_resource.md)
  - [Get product operating systems](https://developers.hivelocity.net/reference/get_product_operating_systems_resource.md)
  - [Get product options](https://developers.hivelocity.net/reference/get_product_option_resource.md)
- Profile
  - [Update Profile of current user or a contact with id](https://developers.hivelocity.net/reference/put_profile_resource.md): The id is optional and if it is necessary must be sent as URL param.
  - [Get Profile of current user or a contact with id](https://developers.hivelocity.net/reference/get_profile_resource.md): The id is optional and if it is necessary must be sent as URL param.
  - [Get Basic Profile of current user or a contact with id](https://developers.hivelocity.net/reference/get_basic_profile_resource.md): The id is optional and if it is necessary must be sent as URL param.
  - [Update user password](https://developers.hivelocity.net/reference/put_password_profile_resource.md)
- [Deployment](https://developers.hivelocity.net/reference/deployment.md): This endpoint is used to handle product deployment actions.
  - [Start a new deployment](https://developers.hivelocity.net/reference/post_deployment_resource.md)
  - [Return a list with all client deployments](https://developers.hivelocity.net/reference/get_deployment_resource.md)
  - [Receive product, quantity and options to be added on the deployment](https://developers.hivelocity.net/reference/put_deployment_id_resource.md)
  - [Delete the specified deployment](https://developers.hivelocity.net/reference/delete_deployment_id_resource.md)
  - [Return a dictionary with deployment information](https://developers.hivelocity.net/reference/get_deployment_id_resource.md)
  - [Input a billing info id and script to process and finish a deployment](https://developers.hivelocity.net/reference/post_deployment_id_resource.md)
- RapidRestore
  - [/rapid-restore/{deviceId}/device-status](https://developers.hivelocity.net/reference/get_device_status_resource.md)
- SAML
  - [Get current client's configuration for authentication with external Identity Providers](https://developers.hivelocity.net/reference/get_saml_service_provider_config_resource.md)
  - [Delete configuration for authentication with external Identity Providers](https://developers.hivelocity.net/reference/delete_saml_service_provider_config_resource.md)
  - [Configure authentication with external Identity Providers](https://developers.hivelocity.net/reference/post_saml_service_provider_config_resource.md)
- Service
  - [Return a list of all account services](https://developers.hivelocity.net/reference/get_service_resource.md)
  - [Return a dictionary with managed services operating system and panel requirements](https://developers.hivelocity.net/reference/get_service_managed_req_resource.md)
  - [Return all available service types](https://developers.hivelocity.net/reference/get_service_type_resource.md)
  - [Return a dictionary with data from a specific account service](https://developers.hivelocity.net/reference/get_service_id_resource.md)
  - [Apply the coupon code for a service](https://developers.hivelocity.net/reference/post_service_id_apply_coupon_resource.md)
  - [Return a dictionary with data verifying managed services eligibility](https://developers.hivelocity.net/reference/get_service_manageable_resource.md)
  - [Validate the coupon code for a service](https://developers.hivelocity.net/reference/post_service_id_validate_coupon_resource.md)
- SshKey
  - [Adds public ssh key](https://developers.hivelocity.net/reference/post_ssh_key_resource.md)
  - [Gets all public ssh keys](https://developers.hivelocity.net/reference/get_ssh_key_resource.md)
  - [Updates public ssh key](https://developers.hivelocity.net/reference/put_ssh_key_id_resource.md)
  - [Removes public ssh key](https://developers.hivelocity.net/reference/delete_ssh_key_id_resource.md)
  - [Get public ssh key](https://developers.hivelocity.net/reference/get_ssh_key_id_resource.md)
- Token
  - [Updates the Public API Token with apiTokenId](https://developers.hivelocity.net/reference/put_token_resource-1.md)
  - [Deletes the Public API Token with apiTokenId](https://developers.hivelocity.net/reference/delete_token_resource-1.md)
  - [Returns a list of Public API Tokens for the current user (last 4 characters only)](https://developers.hivelocity.net/reference/get_token_resource.md)
  - [Create a new Public API Token for the current user](https://developers.hivelocity.net/reference/post_token_resource.md)
- VPS
  - [Get available upgrade options for a VPS product](https://developers.hivelocity.net/reference/get_vps_available_product_upgrades_resource.md)
  - [Get available upgrade options for a VPS product](https://developers.hivelocity.net/reference/get_vps_current_product_resource.md)
- VLAN
  - [Create VLAN](https://developers.hivelocity.net/reference/post_vlan_resource.md)
  - [Get all VLANs](https://developers.hivelocity.net/reference/get_vlan_resource.md)
  - [Modify VLAN](https://developers.hivelocity.net/reference/put_vlan_id_resource.md)
  - [Delete VLAN](https://developers.hivelocity.net/reference/delete_vlan_id_resource.md)
  - [Get VLAN](https://developers.hivelocity.net/reference/get_vlan_id_resource.md)
  - [Clear all configurations on this VLAN, including Ports, IPs and associated Static Routes](https://developers.hivelocity.net/reference/post_vlan_id_clear_resource-1.md)
- VPS
  - [Get all VPS instances](https://developers.hivelocity.net/reference/get_vps_resource.md)
  - [Gets list of available sizes for new volumes](https://developers.hivelocity.net/reference/get_vps_available_new_volumes_resource.md)
  - [Create a new ISO](https://developers.hivelocity.net/reference/post_vpsiso_resource.md)
  - [Get all VPS ISOs available](https://developers.hivelocity.net/reference/get_vpsiso_resource.md)
  - [Delete an ISO](https://developers.hivelocity.net/reference/delete_vpsiso_id_resource.md)
  - [Get the details of the VPS ISO ID specified](https://developers.hivelocity.net/reference/get_vpsiso_id_resource.md)
  - [Create a new VPS Network](https://developers.hivelocity.net/reference/post_vps_network_resource.md)
  - [Get all VPS Networks](https://developers.hivelocity.net/reference/get_vps_network_resource.md)
  - [Update VPS Network](https://developers.hivelocity.net/reference/put_vps_network_id_resource.md)
  - [Delete VPS Network](https://developers.hivelocity.net/reference/delete_vps_network_id_resource.md)
  - [Get VPS Network](https://developers.hivelocity.net/reference/get_vps_network_id_resource.md)
  - [Create a VPS Volume Snapshot](https://developers.hivelocity.net/reference/post_vps_snapshot_resource.md)
  - [Get all VPS Volume Snapshots available](https://developers.hivelocity.net/reference/get_vps_snapshot_resource.md)
  - [Restore a VPS Volume Snapshot](https://developers.hivelocity.net/reference/post_vps_snapshot_id_resource.md)
  - [Delete a VPS Volume Snapshot](https://developers.hivelocity.net/reference/delete_vps_snapshot_id_resource.md)
  - [Get a VPS Volume Snapshot by ID](https://developers.hivelocity.net/reference/get_vps_snapshot_id_resource.md)
  - [Create a VPS Snapshot Schedule](https://developers.hivelocity.net/reference/post_vps_snapshot_schedule_resource.md)
  - [Get all VPS Snapshot Schedules for a Facility or VPS Instance](https://developers.hivelocity.net/reference/get_vps_snapshot_schedule_resource.md)
  - [Delete a VPS Snapshot Schedule](https://developers.hivelocity.net/reference/delete_vps_snapshot_schedule_id_resource.md)
  - [Get a VPS Snapshot Schedules](https://developers.hivelocity.net/reference/get_vps_snapshot_schedule_id_resource.md)
  - [Creates a new Volume](https://developers.hivelocity.net/reference/post_vps_volume_resource.md): Warning: This endpoint incurs charges. The volume will be billed monthly regardless of attached device's billing cycle length.
  - [Get all VPS Instance Volumes available](https://developers.hivelocity.net/reference/get_vps_volume_resource.md)
  - [Resize a Volume](https://developers.hivelocity.net/reference/put_vps_volume_id_resource.md): Warning: This endpoint incurs charges.
  - [Deletes a Volume](https://developers.hivelocity.net/reference/delete_vps_volume_id_resource.md): Warning: This will cancel the monthly billing service for this volume
  - [Get a VPS Instance Volume](https://developers.hivelocity.net/reference/get_vps_volume_id_resource.md)
  - [Get a volume's list of upgradable sizes](https://developers.hivelocity.net/reference/get_vps_available_upgrade_sizes_resource.md)
  - [Update VPS instance](https://developers.hivelocity.net/reference/put_vps_id_resource.md): This will incur additional charges if scaling up.
  - [Get VPS instance](https://developers.hivelocity.net/reference/get_vps_id_resource.md)
  - [Attach ISO to VPS instance](https://developers.hivelocity.net/reference/post_vps_attach_iso_resource.md)
  - [Create a one time use URL for console access to a VPS instance](https://developers.hivelocity.net/reference/post_vps_console_access_resource.md)
  - [Detach ISO from VPS instance](https://developers.hivelocity.net/reference/post_vps_detach_iso_resource.md)
  - [Get VPS Instance Events](https://developers.hivelocity.net/reference/get_vps_id_events_resource.md)
  - [Get Metrics for a VPS instance](https://developers.hivelocity.net/reference/get_vps_metrics_resource.md)
  - [Attach VPS Network to a VPS Device](https://developers.hivelocity.net/reference/post_vps_id_network_add_resource.md)
  - [Detach a VPS Network from a VPS Device](https://developers.hivelocity.net/reference/delete_vps_id_network_remove_resource.md)
  - [Request token to reset root password for VPS](https://developers.hivelocity.net/reference/post_vps_reset_password_resource.md)
  - [Reset VPS root password, requires vps to be powered off](https://developers.hivelocity.net/reference/put_vps_reset_password_resource.md)
  - [Add a Secondary IP Address to VPS instance](https://developers.hivelocity.net/reference/post_vps_secondary_ip_add_resource.md)
  - [Get all Secondary IP Addresses attached to VPS instance](https://developers.hivelocity.net/reference/get_vps_secondary_ip_add_resource.md)
  - [Remove a Secondary IP Address from VPS instance](https://developers.hivelocity.net/reference/delete_vps_secondary_ip_remove_resource.md)
  - [Attach Volume to VPS instance](https://developers.hivelocity.net/reference/post_vps_attach_volume_resource.md)
  - [Detach Volume from VPS instance](https://developers.hivelocity.net/reference/post_vps_detach_volume_resource.md)
- Webhook
  - [Create a new Webhook for a Webhook Event](https://developers.hivelocity.net/reference/post_webhook_resource.md)
  - [Returns your active Webhooks](https://developers.hivelocity.net/reference/get_webhook_resource.md)
  - [Returns all available Webhook Events](https://developers.hivelocity.net/reference/get_webhook_event_resource.md)
  - [Queues a webhook for the event script action that was triggered](https://developers.hivelocity.net/reference/post_event_script_action_trigger_resource.md)
  - [Updates a Single Webhook](https://developers.hivelocity.net/reference/put_webhook_id_resource.md)
  - [Deletes a single webhook](https://developers.hivelocity.net/reference/delete_webhook_id_resource.md)
  - [Returns detailed information for a Single Webhook](https://developers.hivelocity.net/reference/get_webhook_id_resource.md)
  - [/webhooks/etl](https://developers.hivelocity.net/reference/post_etl_webhook_resource.md)

## Recipes
- [Deploying Flatcar in a private VLAN](https://developers.hivelocity.net/recipes/deploying-flatcar-in-a-private-vlan.md)
- [Example Ignition file for private VLAN with Terraform](https://developers.hivelocity.net/recipes/example-ignition-file-for-private-vlan-with-terraform.md)
- [Get all hourly billing servers](https://developers.hivelocity.net/recipes/get-all-hourly-billing-servers.md)
- [Reload a Custom Server](https://developers.hivelocity.net/recipes/reload-a-custom-server.md)
- [Reload a device with custom iPXE](https://developers.hivelocity.net/recipes/reload-a-device-with-custom-ipxe.md)

## Pages
- [|=| Hivelocity Service Status](https://developers.hivelocity.net/page/service-status.md)

## Changelog
- [September 2026](https://developers.hivelocity.net/changelog/september-2026.md)
- [August 2026](https://developers.hivelocity.net/changelog/august-2026.md)
- [July 2026](https://developers.hivelocity.net/changelog/july-2026.md)
- [June 2026](https://developers.hivelocity.net/changelog/june-2026.md)
- [May 2026](https://developers.hivelocity.net/changelog/may-2026.md)
- [April 2026](https://developers.hivelocity.net/changelog/april-2026.md)
- [March 2026](https://developers.hivelocity.net/changelog/march-2026.md)
- [February 2026](https://developers.hivelocity.net/changelog/february-2026.md)
- [January 12 - February 1, 2026](https://developers.hivelocity.net/changelog/january-12-february-1-2026.md)
- [December 15, 2025 - January 11, 2026](https://developers.hivelocity.net/changelog/december-15-2025-january-11-2026.md)