JUMP TOGetting StartedIntroductionHivelocity APIAccountGet all controlled clients for enterprise ownergetCreate controlled client for enterprise ownerpostDeactivate clientputApps/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 devicespostGet devicegetUpdate/reload instant deviceputCancel/delete devicedeleteCompute DevicesGet all devicesgetProvision an instant devicepostBatch provision instant devicespostGet devicegetUpdate/reload instant deviceputCancel/delete devicedeleteBillingInfoReturn a list with all Payment Methods (Billing Info)getCreate verification for credit card with all Billing InfopostVerify credit card with all Billing InfoputAdd 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 IDdeleteCancellationsGet 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 request to reset password, and send a link by email with tokenpostReceive a token and password, verify the user and reset your passwordputReturn details of a specific ContactgetEdit a ContactputDelete a ContactdeleteChange 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 tagsgetGet tag ordergetUpdate tag orderputGet all tag ordersgetGet devicegetUpdate deviceputGet all eventsgetGet Ignition injectionsgetGet initial credsgetGet initial passwordgetGet IPMI datagetGet IPMI Java ConsolepostGet IPMI credsgetClear IPMI whitelistgetGet IPMI noVNC ConsolepostGet IPMI thresholdsgetUpdate IPMI thresholdsputGet IPMI access statusgetWhitelist IP for IPMIpostGet IPsgetClear all Port configurationspostGet portsgetUpdate port networkputBond portspostUnbond portsdeleteGet power statusgetUpdate power statuspostGet reload infogetReload devicepostGet all device servicesgetGet device tagsgetUpdate device tagsputDomainsReturn the domains of a clientgetCreate a new domainpostReturn the PTR records of a clientgetGet PTR record by ID and namegetUpdate PTR recordputReturn the registered domains of a clientgetReturn all AAAA Records found for given zonegetCreate a new AAAA Record for given zonepostReturn Single AAAA Records found for given idgetUpdate an AAAA Record for given idputDelete an AAAA Record for given zonedeleteReturn all MX Records found for given zonegetCreate a new MX Record for given zonepostReturn Single MX Records found for given idgetUpdate an MX Record for given zoneputDelete an MX Record for given zonedeleteReturn a domain for given idgetDelete domain for given iddeleteReturn all A Records found for given zone namegetCreate a new A Record for given zonepostReturn Single A Records found for given domain namegetUpdate an A Record for given zoneputDelete a single A Record value for given zonedeleteIgnitionReturn all Ignition configurationsgetCreates a new Ignition configurationpostReturn an Ignition configuration by IDgetUpdate an Ignition configuration by IDputDelete 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 FormatgetIPAssignmentGet all assignmentsgetRequest new assignmentpostGet assignment by IPgetCombine assignmentspostGet assignmentgetRoute assignment to IPputDelete assignmentdeleteClear 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 AddresspostReturn record if IP Address is Null RoutedgetRemove Null Route for an IP AddressdeleteGet 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 GroupsReturn a list with all Order GroupsgetCreate a new Order GrouppostReturn an Order GroupgetUpdate an Order GroupputDelete 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 optionsgetProfileGet Profile of current user or a contact with idgetUpdate Profile of current user or a contact with idputGet Basic Profile of current user or a contact with idgetUpdate user passwordputDeploymentReturn a list with all client deploymentsgetStart a new deploymentpostReturn a dictionary with deployment informationgetInput a billing info id and script to process and finish a deploymentpostReceive product, quantity and options to be added on the deploymentputDelete 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 servicepostSshKeyGets all public ssh keysgetAdds public ssh keypostGet public ssh keygetUpdates public ssh keyputRemoves public ssh keydeleteTicketReturns a list with all TicketsgetCreates a new ticketpostReturn results of ticket searchgetReturns details of a specific ticketgetUpdates a specific ticketputReturns a reply for a specific ticketgetCreates reply for a specific TicketpostTokenReturns a list of Public API Tokens for the current user (last 4 characters only)getCreate a new Public API Token for the current userpostUpdates the Public API Token with apiTokenIdputDeletes the Public API Token with apiTokenIddeleteVLANGet all VLANsgetCreate VLANpostGet VLANgetModify VLANputDelete VLANdeleteClear 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 ISOpostGet the details of the VPS ISO ID specifiedgetDelete an ISOdeleteGet all VPS NetworksgetCreate a new VPS NetworkpostGet VPS NetworkgetUpdate VPS NetworkputDelete VPS NetworkdeleteGet all VPS Volume Snapshots availablegetCreate a VPS Volume SnapshotpostGet a VPS Volume Snapshot by IDgetRestore a VPS Volume SnapshotpostDelete a VPS Volume SnapshotdeleteGet all VPS Snapshot Schedules for a Facility or VPS InstancegetCreate a VPS Snapshot SchedulepostGet a VPS Snapshot SchedulesgetDelete a VPS Snapshot ScheduledeleteGet all VPS Instance Volumes availablegetCreates a new VolumepostGet a VPS Instance VolumegetResize a VolumeputDeletes a VolumedeleteGet a volume's list of upgradable sizesgetGet VPS instancegetUpdate VPS instanceputAttach 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 offputGet 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 triggeredpostReturns detailed information for a Single WebhookgetUpdates a Single WebhookputDeletes a single webhookdeletePowered by Create a VPS Snapshot Schedulepost https://core.hivelocity.net/api/v2/vps/snapshotScheduleAdditional details can be found here: VPS Snapshots