JUMP TOGetting StartedIntroductionHivelocity APIAccountCreate controlled client for enterprise ownerpostDeactivate clientputGet all controlled clients for enterprise ownergetApps/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 DevicesProvision an instant devicepostGet all devicesgetBatch provision instant devicespostCancel/delete devicedeleteUpdate/reload instant deviceputGet devicegetCompute DevicesProvision an instant devicepostGet all devicesgetBatch provision instant devicespostCancel/delete devicedeleteUpdate/reload instant deviceputGet devicegetBillingInfoCreate verification for credit card with all Billing InfopostVerify credit card with all Billing InfoputReturn 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 editinggetDelete a Payment Method by Billing Info IDdeleteReturn a Payment Method by Billing Info IDgetCancellationsCreate 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 request to reset password, and send a link by email with tokenpostReceive a token and password, verify the user and reset your passwordputDelete a ContactdeleteEdit a ContactputReturn details of a specific ContactgetChange 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 portsgetUnbond portsdeleteBond portspostUpdate 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 zonegetDelete an AAAA Record for given zonedeleteUpdate an AAAA Record for given idputReturn Single AAAA Records found for given idgetCreate a new MX Record for given zonepostReturn all MX Records found for given zonegetDelete 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 idgetCreate a new A Record for given zonepostReturn all A Records found for given zone namegetDelete a single A Record value for given zonedeleteUpdate an A Record for given zoneputReturn Single A Records found for given domain namegetIgnitionCreates a new Ignition configurationpostReturn all Ignition configurationsgetDelete 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 FormatgetIPAssignmentRequest new assignmentpostGet all assignmentsgetGet 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 devicegetAdd a Null Route for an IP AddresspostReturn Null Routed IPsgetRemove Null Route for an IP AddressdeleteReturn record if IP Address is Null RoutedgetGet network task statusgetGet network task status by Device ID or Task IDgetOrderReturn 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 GroupsgetDelete 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 passwordputDeploymentStart a new deploymentpostReturn a list with all client deploymentsgetDelete the specified deploymentdeleteInput a billing info id and script to process and finish a deploymentpostReceive product, quantity and options to be added on the deploymentputReturn a dictionary with deployment informationgetRapidRestore/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 keysgetRemoves public ssh keydeleteUpdates public ssh keyputGet public ssh keygetTicketCreates 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 ticketgetTokenDeletes the Public API Token with apiTokenIddeleteCreate a new Public API Token for the current userpostReturns a list of Public API Tokens for the current user (last 4 characters only)getUpdates the Public API Token with apiTokenIdputVLANCreate VLANpostGet all VLANsgetDelete VLANdeleteModify VLANputGet VLANgetClear 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 availablegetDelete an ISOdeleteGet the details of the VPS ISO ID specifiedgetCreate a new VPS NetworkpostGet all VPS NetworksgetDelete VPS NetworkdeleteUpdate VPS NetworkputGet VPS NetworkgetCreate a VPS Volume SnapshotpostGet all VPS Volume Snapshots availablegetDelete a VPS Volume SnapshotdeleteRestore a VPS Volume SnapshotpostGet a VPS Volume Snapshot by IDgetCreate a VPS Snapshot SchedulepostGet all VPS Snapshot Schedules for a Facility or VPS InstancegetDelete a VPS Snapshot ScheduledeleteGet a VPS Snapshot SchedulesgetCreates a new VolumepostGet all VPS Instance Volumes availablegetDeletes 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 DevicedeleteRequest token to reset root password for VPSpostReset VPS root password, requires vps to be powered offputAdd 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 triggeredpostDeletes a single webhookdeleteUpdates a Single WebhookputReturns detailed information for a Single WebhookgetPowered by Create VLANpost https://core.hivelocity.net/api/v2/vlan/