JUMP TOGetting StartedIntroductionHivelocity APIAccountDeactivate clientputGet all controlled clients for enterprise ownergetCreate controlled client for enterprise ownerpostApps/apps/getRetrieve help text for a specific app after provisioninggetRetrieve help text for a specific app after provisioningget/apps/{appId}/validate-formpostBandwidthGet data by devicepostGet PNG by devicepostGet data by servicepostGet PNG by servicepostBare Metal DevicesGet all devicesgetProvision an instant devicepostBatch provision instant devicespostCancel/delete devicedeleteUpdate/reload instant deviceputGet devicegetCompute DevicesGet all devicesgetProvision an instant devicepostBatch provision instant devicespostCancel/delete devicedeleteUpdate/reload instant deviceputGet devicegetBillingInfoVerify credit card with all Billing InfoputReturn a list with all Payment Methods (Billing Info)getCreate verification for credit card with all Billing InfopostAdd 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 editinggetDelete a Payment Method by Billing Info IDdeleteReturn a Payment Method by Billing Info IDgetCancellationsGet all cancel requestsgetCreate cancel requestpostDelete a CancellationdeleteGet cancel request by devicegetGet all cancellation reasons for a DevicegetGet cancel request by servicegetContactReturn a list with all ContactsgetCreate a new ContactpostReceive a token and password, verify the user and reset your passwordputReceive a request to reset password, and send a link by email with tokenpostDelete a ContactdeleteEdit a ContactputReturn details of a specific ContactgetChange password for a ContactputCreditReturn a list with all CreditsgetReceive billing method id and amount and return the created CreditpostApply 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 portsgetUnbond portsdeleteBond portspostGet power statusgetUpdate power statuspostGet reload infogetReload devicepostGet all device servicesgetUpdate device tagsputGet device tagsgetDomainsReturn the domains of a clientgetCreate a new domainpostReturn the PTR records of a clientgetUpdate PTR recordputGet PTR record by ID and namegetReturn the registered domains of a clientgetReturn all AAAA Records found for given zonegetCreate a new AAAA Record for given zonepostDelete an AAAA Record for given zonedeleteUpdate an AAAA Record for given idputReturn Single AAAA Records found for given idgetReturn all MX Records found for given zonegetCreate a new MX Record for given zonepostDelete an MX Record for given zonedeleteUpdate an MX Record for given zoneputReturn Single MX Records found for given idgetDelete domain for given iddeleteReturn a domain for given idgetReturn all A Records found for given zone namegetCreate a new A Record for given zonepostDelete a single A Record value for given zonedeleteUpdate an A Record for given zoneputReturn Single A Records found for given domain namegetIgnitionReturn all Ignition configurationsgetCreates a new Ignition configurationpostDelete an Ignition configuration by IDdeleteUpdate an Ignition configuration by IDputReturn an Ignition configuration by IDgetInventoryGet 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 FormatgetIPAssignmentGet all assignmentsgetRequest new assignmentpostGet assignment by IPgetCombine assignmentspostDelete assignmentdeleteRoute assignment to IPputGet assignmentgetClear all configuration on an IP AssignmentpostSplit assignmentpostMaintenanceGet all Maintenance Events for a clientgetGet Maintenance EventsgetNetworkGet Cloud Interconnect PortsgetGet all ports by devicegetReturn Null Routed IPsgetAdd a Null Route for an IP AddresspostRemove Null Route for an IP AddressdeleteReturn record if IP Address is Null RoutedgetGet 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 GroupsReturn a list with all Order GroupsgetCreate a new Order GrouppostDelete the specified Order GroupdeleteUpdate an Order GroupputReturn an Order GroupgetPermissionEndpoint 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 passwordputDeploymentReturn a list with all client deploymentsgetStart a new deploymentpostDelete the specified deploymentdeleteReceive product, quantity and options to be added on the deploymentputReturn a dictionary with deployment informationgetInput a billing info id and script to process and finish a deploymentpostRapidRestore/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 servicepostSshKeyGets all public ssh keysgetAdds public ssh keypostRemoves public ssh keydeleteUpdates public ssh keyputGet public ssh keygetTicketReturns a list with all TicketsgetCreates a new ticketpostReturn results of ticket searchgetUpdates a specific ticketputReturns details of a specific ticketgetReturns a reply for a specific ticketgetCreates reply for a specific TicketpostTokenDeletes the Public API Token with apiTokenIddeleteUpdates the Public API Token with apiTokenIdputReturns a list of Public API Tokens for the current user (last 4 characters only)getCreate a new Public API Token for the current userpostVLANGet all VLANsgetCreate VLANpostDelete VLANdeleteModify VLANputGet VLANgetClear all configurations on this VLAN, including Ports, IPs and associated Static RoutespostVPSGet all VPS instancesgetGets list of available sizes for new volumesgetGet all VPS ISOs availablegetCreate a new ISOpostDelete an ISOdeleteGet the details of the VPS ISO ID specifiedgetGet all VPS NetworksgetCreate a new VPS NetworkpostDelete VPS NetworkdeleteUpdate VPS NetworkputGet VPS NetworkgetGet all VPS Volume Snapshots availablegetCreate a VPS Volume SnapshotpostDelete a VPS Volume SnapshotdeleteGet a VPS Volume Snapshot by IDgetRestore a VPS Volume SnapshotpostGet all VPS Snapshot Schedules for a Facility or VPS InstancegetCreate a VPS Snapshot SchedulepostDelete a VPS Snapshot ScheduledeleteGet a VPS Snapshot SchedulesgetGet all VPS Instance Volumes availablegetCreates a new VolumepostDeletes a VolumedeleteResize a VolumeputGet a VPS Instance VolumegetGet 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 VPSpostGet all Secondary IP Addresses attached to VPS instancegetAdd a Secondary IP Address to VPS instancepostRemove a Secondary IP Address from VPS instancedeleteAttach Volume to VPS instancepostDetach Volume from VPS instancepostWebhookReturns your active WebhooksgetCreate a new Webhook for a Webhook EventpostReturns all available Webhook EventsgetQueues a webhook for the event script action that was triggeredpostDeletes a single webhookdeleteUpdates a Single WebhookputReturns detailed information for a Single WebhookgetPowered by Get the details of the VPS ISO ID specifiedget https://core.hivelocity.net/api/v2/vps/iso/{isoId}Additional details can be found here: VPS ISO and Volume Operations