JUMP TOGetting StartedIntroductionHivelocity APIAccountDeactivate clientputCreate controlled client for enterprise ownerpostGet all controlled clients for enterprise ownergetBackupGet Veeam statusgetBandwidthGet data by devicepostGet PNG by devicepostGet data by servicepostGet PNG by servicepostBare Metal DevicesProvision an instant devicepostGet all devicesgetBatch provision instant devicespostUpdate/reload instant deviceputGet devicegetCancel/delete devicedeleteCompute DevicesProvision an instant devicepostGet all devicesgetBatch provision instant devicespostUpdate/reload instant deviceputGet devicegetCancel/delete devicedeleteBillingInfoVerify credit card with all Billing InfoputCreate verification for credit card with all Billing InfopostReturn a list with all Payment Methods (Billing Info)getAdd a new Bank Account as a Payment MethodpostUpdate a Bank AccountputAdd a new Credit Card as a Payment MethodpostUpdate a Credit CardputReturn Payment Methods enabled for editinggetReturn a Payment Method by Billing Info IDgetDelete a Payment Method by Billing Info IDdeleteCancellationsCreate cancel requestpostGet all cancel requestsgetDelete a CancellationdeleteGet cancel request by devicegetGet all cancellation reasons for a DevicegetGet cancel request by servicegetContactCreate a new ContactpostReturn a list with all ContactsgetReceive a token and password, verify the user and reset your passwordputReceive a request to reset password, and send a link by email with tokenpostEdit a ContactputReturn details of a specific ContactgetDelete a ContactdeleteChange password for a ContactputCreditReceive billing method id and amount and return the created CreditpostReturn a list with all CreditsgetApply the coupon code for a servicepostReturn the client's total active credit amountgetValidate the coupon code for a servicepostDeviceGet all devicesgetBulk update IPMI thresholdsputGet by payment methodgetPreview Ignition injectionspostGet all tagsgetUpdate tag orderputGet tag ordergetGet all tag ordersgetUpdate deviceputGet devicegetGet all eventsgetGet Ignition injectionsgetGet initial credsgetGet initial passwordgetGet IPMI datagetGet IPMI Java ConsolepostGet IPMI credsgetClear IPMI whitelistgetGet IPMI noVNC ConsolepostUpdate IPMI thresholdsputGet IPMI thresholdsgetGet IPMI access statusgetWhitelist IP for IPMIpostGet IPsgetClear all Port configurationspostUpdate port networkputGet portsgetBond portspostUnbond portsdeleteUpdate power statuspostGet power statusgetReload devicepostGet reload infogetGet all device servicesgetUpdate device tagsputGet device tagsgetDomainsCreate a new domainpostReturn the domains of a clientgetReturn the PTR records of a clientgetUpdate PTR recordputGet PTR record by ID and namegetReturn the registered domains of a clientgetCreate a new AAAA Record for given zonepostReturn all AAAA Records found for given zonegetUpdate an AAAA Record for given idputReturn Single AAAA Records found for given idgetDelete an AAAA Record for given zonedeleteCreate a new MX Record for given zonepostReturn all MX Records found for given zonegetUpdate an MX Record for given zoneputReturn Single MX Records found for given idgetDelete an MX Record for given zonedeleteReturn a domain for given idgetDelete domain for given iddeleteCreate a new A Record for given zonepostReturn all A Records found for given zone namegetUpdate an A Record for given zoneputReturn Single A Records found for given domain namegetDelete a single A Record value for given zonedeleteIgnitionCreates a new Ignition configurationpostReturn all Ignition configurationsgetUpdate an Ignition configuration by IDputReturn an Ignition configuration by IDgetDelete an Ignition configuration by IDdeleteInventoryGet all facilitiesgetGet all productsgetGet productgetInvoiceReturn serialized data on all invoicesgetReturn results of invoice searchgetReturn total balance of all unpaid invoicesgetReturn serialized data on a single invoicegetApply account credit to an invoicepostReturn detailed information for an invoicegetReturn an Invoice PDF file in Base64 Encoded FormatgetIPAssignmentRequest new assignmentpostGet all assignmentsgetGet assignment by IPgetCombine assignmentspostRoute assignment to IPputGet assignmentgetDelete assignmentdeleteClear all configuration on an IP AssignmentpostSplit assignmentpostMaintenanceGet all Maintenance Events for a clientgetGet Maintenance EventsgetNetworkGet Cloud Interconnect PortsgetGet all ports by devicegetAdd a Null Route for an IP AddresspostReturn Null Routed IPsgetReturn record if IP Address is Null RoutedgetRemove Null Route for an IP AddressdeleteGet network task statusgetGet network task status by Device ID or Task IDgetoptionGet all Apps plan options grouped by option groupgetOrderReturn a list with all OrdersgetReturn a list of all In-Progress ordersgetReturn details of a specific OrdergetOrder GroupsCreate a new Order GrouppostReturn a list with all Order GroupsgetUpdate an Order GroupputReturn an Order GroupgetDelete the specified Order GroupdeletePermissionEndpoint to get All PermissionsgetEndpoint to assign a new Permission to a ContactpostEndpoint to get Contact PermissionsgetEndpoint to get User PermissionsgetPrivateCloud/private-cloud/config/samlpostProductGet all optionsgetGet product operating systemsgetGet product optionsgetProfileUpdate Profile of current user or a contact with idputGet Profile of current user or a contact with idgetGet Basic Profile of current user or a contact with idgetUpdate user passwordputDeploymentStart a new deploymentpostReturn a list with all client deploymentsgetReceive product, quantity and options to be added on the deploymentputInput a billing info id and script to process and finish a deploymentpostReturn a dictionary with deployment informationgetDelete the specified deploymentdeleteRapidRestore/rapid-restore/{deviceId}/device-statusgetServiceReturn a list of all account servicesgetReturn a dictionary with managed services operating system and panel requirementsgetReturn all available service typesgetReturn a dictionary with data from a specific account servicegetApply the coupon code for a servicepostReturn a dictionary with data verifying managed services eligibilitygetValidate the coupon code for a servicepostSshKeyAdds public ssh keypostGets all public ssh keysgetUpdates public ssh keyputGet public ssh keygetRemoves public ssh keydeleteTicketCreates a new ticketpostReturns a list with all TicketsgetReturn results of ticket searchgetUpdates a specific ticketputReturns details of a specific ticketgetCreates reply for a specific TicketpostReturns a reply for a specific ticketgetTokenUpdates the Public API Token with apiTokenIdputCreate a new Public API Token for the current userpostReturns a list of Public API Tokens for the current user (last 4 characters only)getDeletes the Public API Token with apiTokenIddeleteVLANCreate VLANpostGet all VLANsgetModify VLANputGet VLANgetDelete VLANdeleteClear all configurations on this VLAN, including Ports, IPs and associated Static RoutespostVPSGet all VPS instancesgetGets list of available sizes for new volumesgetCreate a new ISOpostGet all VPS ISOs availablegetGet the details of the VPS ISO ID specifiedgetDelete an ISOdeleteCreate a new VPS NetworkpostGet all VPS NetworksgetUpdate VPS NetworkputGet VPS NetworkgetDelete VPS NetworkdeleteCreate a VPS Volume SnapshotpostGet all VPS Volume Snapshots availablegetRestore a VPS Volume SnapshotpostGet a VPS Volume Snapshot by IDgetDelete a VPS Volume SnapshotdeleteCreate a VPS Snapshot SchedulepostGet all VPS Snapshot Schedules for a Facility or VPS InstancegetGet a VPS Snapshot SchedulesgetDelete a VPS Snapshot ScheduledeleteCreates a new VolumepostGet all VPS Instance Volumes availablegetResize a VolumeputGet a VPS Instance VolumegetDeletes a VolumedeleteGet a volume's list of upgradable sizesgetUpdate VPS instanceputGet VPS instancegetAttach ISO to VPS instancepostCreate a one time use URL for console access to a VPS instancepostDetach ISO from VPS instancepostGet VPS Instance EventsgetGet Metrics for a VPS instancegetAttach VPS Network to a VPS DevicepostDetach a VPS Network from a VPS DevicedeleteReset VPS root password, requires vps to be powered offputRequest token to reset root password for VPSpostAdd a Secondary IP Address to VPS instancepostGet all Secondary IP Addresses attached to VPS instancegetRemove a Secondary IP Address from VPS instancedeleteAttach Volume to VPS instancepostDetach Volume from VPS instancepostWebhookCreate a new Webhook for a Webhook EventpostReturns your active WebhooksgetReturns all available Webhook EventsgetQueues a webhook for the event script action that was triggeredpostUpdates a Single WebhookputReturns detailed information for a Single WebhookgetDeletes a single webhookdeletePowered by Delete VLANdelete https://core.hivelocity.net/api/v2/vlan/{vlanId}