JUMP TOGetting StartedIntroductionHivelocity APIAccountGet all controlled clients for enterprise ownergetCreate controlled client for enterprise ownerpostDeactivate clientputBandwidthGet data by devicepostGet PNG by devicepostGet data by servicepostGet PNG by servicepostBare Metal DevicesGet all devicesgetProvision an instant devicepostBatch provision instant devicespostGet devicegetCancel/delete devicedeleteUpdate/reload instant deviceputBillingInfoReturn a list with all Billing InfogetCreate verification for credit card with all Billing InfopostVerify credit card with all Billing InfoputCancellationsGet all cancel requestsgetCreate cancel requestpostGet cancel requestgetGet cancel request by 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 ContactgetDelete a ContactdeleteEdit a ContactputChange 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 servicepostDeploymentReturn 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 deploymentpostDelete the specified deploymentdeleteReceive product, quantity and options to be added on the deploymentputDeviceGet all devicesgetBulk update IPMI thresholdsputPreview Ignition injectionspostGet all tagsgetGet tag ordergetUpdate tag orderputGet all tag ordersgetGet devicegetUpdate deviceputGet all eventsgetGet Ignition injectionsgetGet initial credsgetGet initial passwordgetGet IPMI datagetGet IPMI credsgetClear IPMI whitelistgetGet IPMI thresholdsgetUpdate IPMI thresholdsputGet IPMI access statusgetWhitelist IP for IPMIpostGet IPsgetClear all Port configurationspostGet portsgetUpdate port networkputBond portspostUnbond portsdeleteGet power statusgetUpdate power statuspostReload 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 all AAAA Records found for given zonegetCreate a new AAAA Record for given zonepostReturn Single AAAA Records found for given idgetDelete an AAAA Record for given zonedeleteUpdate an AAAA Record for given idputReturn all MX Records found for given zonegetCreate a new MX Record for given zonepostReturn Single MX Records found for given idgetDelete an MX Record for given zonedeleteUpdate an MX Record for given zoneputReturn 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 namegetDelete a single A Record value for given zonedeleteUpdate an A Record for given zoneputIgnitionReturn all Ignition configurationsgetCreates a new Ignition configurationpostReturn an Ignition configuration by IDgetDelete an Ignition configuration by IDdeleteUpdate an Ignition configuration by IDputInventoryGet 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 invoicepostApply 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 IPputDelete assignmentdeleteGet assignmentgetClear all configuration on an IP AssignmentpostSplit assignmentpostMaintenanceGet all Maintenance Events for a clientgetGet Maintenance EventsgetNetworkGet 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 IDgetOrder GroupsCreate a new Order GrouppostReturn a list with all Order GroupsgetUpdate an Order GroupputDelete the specified Order GroupdeleteReturn an Order GroupgetOrderReturn a list with all OrdersgetReturn a list of all In-Progress ordersgetReturn details of a specific OrdergetPermissionEndpoint to get All PermissionsgetEndpoint to assign a new Permission to a ContactpostEndpoint to get Contact PermissionsgetEndpoint to get User PermissionsgetProductGet 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 idgetServiceReturn 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 keygetUpdates public ssh keyputRemoves public ssh keydeleteGet 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 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 VLANputDelete VLANdeleteGet VLANgetClear all configurations on this VLAN, including Ports, IPs and associated Static RoutespostVPSGets 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 VPS Volume SnapshotpostGet all VPS Volume Snapshots availablegetRestore a VPS Volume SnapshotpostDelete a VPS Volume SnapshotdeleteGet a VPS Volume Snapshot by IDgetCreate 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 VolumeputDeletes a VolumedeleteGet a VPS Instance VolumegetGet a volume's list of upgradable sizesgetUpdate VPS instanceputDelete VPS instancedeleteGet 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 instancegetAdd a Secondary IP Address to VPS instancepostGet all Secondary IP Addresses attached to VPS instancegetRemove a Secondary IP Address from VPS instancedeleteWebhookCreate 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 WebhookputDeletes a single webhookdeleteReturns detailed information for a Single WebhookgetPowered by Return serialized data on a single invoiceget https://core.hivelocity.net/api/v2/invoice/{invoiceId}