JUMP TOGetting StartedIntroductionHivelocity APIBandwidthGet bandwidth data by devicepostGet bandwidth PNG by devicepostGet bandwidth by servicepostGet bandwidth PNG by servicepostBare Metal DevicesProvision an instant devicepostGet all devicesgetBatch provision instant devicespostUpdate instant deviceputCancel devicedeleteGet devicegetBillingInfoVerify credit card with all Billing InfoputCreate verification for credit card with all Billing InfopostReturn a list with all Billing InfogetCancellationsCreate cancel requestpostGet all cancel requestsgetGet cancel requestgetGet cancel request by devicegetGet cancel request by servicegetContactCreate a new ContactpostReturn a list with all ContactsgetRecieve a token and password, verify the user and reset your passwordputRecieve a request to reset password, and send a link by email with tokenpostEdit a ContactputDelete a ContactdeleteReturn details of a specific ContactgetChange password for a ContactputCreditReceive billing method id and amount and return the created CreditpostReturn a list with all CreditsgetReturn the client's total active credit amountgetDeploymentStart 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 deploymentpostDelete the specified deploymentdeleteReturn a dictionary with deployment informationgetDeviceReturn Active Devices and basic MetaDatagetUpdates IPMI thresholds for device listputGiven an Ignition file and other parameters, output the effective Ignition file used for provisioningpostGet all device tags for current clientgetUpdate device tags order for current userputGet device tags order for current usergetGet all device tags ordergetUpdates Device MetaData for a Single DeviceputReturns detailed information for a Single DevicegetReturns all Events found for a single devicegetRetrieves a client's ignition file for a provisioning device after SPS's changes are injectedgetReturns initial password for the devicegetReturns initial password for the devicegetReturns IPMI info datagetReturns IPMI login credentialsgetClear NAT rules based on the device client idgetUpdates IPMI thresholds dataputReturns IPMI thresholds datagetReturns if device have valid credentials for IPMI logingetAdd a public IP on IPMI whitelistpostReturn All IP Assignments bound to a DevicegetAllows Network Management of a Device PortputReturns a list of all Network Ports on a DevicegetUnbonds public and private ports of a DevicedeleteBonds public and private ports of a DevicepostApply action to device powerpostGet device's current power statusgetReload any SPS Device with any available OSpostUpdate device tagsputGet device tagsgetDomainsCreate a new domainpostReturn the domains of a clientgetReturn the PTR records of a clientget/domains/ptr/{recordId}put/domains/ptr/{recordId}getCreate a new AAAA Record for given zonepostReturn all AAAA Records found for given zonegetUpdate an AAAA Record for given idputDelete an AAAA Record for given zonedeleteReturn Single AAAA Records found for given idgetCreate a new MX Record for given zonepostReturn all MX Records found for given zonegetUpdate an MX Record for given zoneputDelete an MX Record for given zonedeleteReturn 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 namegetUpdate an A Record for given zoneputDelete a single A Record value for given zonedeleteReturn Single A Records found for given domain namegetIgnitionCreates a new Ignition configurationpostGets an Ignition configurationget/ignition/{ignitionId}put/ignition/{ignitionId}delete/ignition/{ignitionId}getInventoryReturn sps facilities and locationsgetReturn structured sps stock data, grouped by city or facility code for all productsgetReturn a structured sps stock data, grouped by city or facility code for a single productgetInvoiceReturn serialized data on all invoicesgetReturn results of invoice searchgetReturn total balance of all unpaid invoicesgetReturn serialized data on a single invoicegetReturn detailed information for an invoicegetReturn an Invoice PDF file in Base64 Encoded FormatgetIPAssignmentRequest a new IP AssignmentpostReturn All IP Assignments for a Client AccountgetReturn an IP Assignment matching the provided addressgetCombines multiple IP AssignmentspostAdd or remove a static routeputDeletes an existing IP AssignmentdeleteReturn a Single IP Assignment by the Unique IP Assignment IDgetSplits an existing IP AssignmentpostNetworkReturns a list of all Network Ports and Associated Devices belonging to a ClientgetNull route an IP (with custom comments)postNull route an IPgetReturns the Last Status for a long running Network Task, such as modifying a VLANgetReturns the Last Status for a long running Network Task, such as modifying a VLANgetRemove null route from an IPgetOrder 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 with all 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 PermissionsgetProductReturn structured sps stock data in a listgetReturn a mapping of Products and Options with pricing per-periodgetReturn List of operating systems found for a ProductgetReturn List of Options found for a ProductgetProfileUpdate 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 a dictionary with data from a specific account servicegetReturn a dictionary with data verifying managed services eligibilitygetSshKeyAdds 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 ticketgetTokenCreate a new Public API Token for the current userpostReturns a list of Public API Tokens for the current usergetUpdates the Public API TokenputDeletes the Public API TokendeleteReturns Public API TokengetVLANCreate a new VLANpostReturn a list with all VLANsgetUpdate an existing VLAN, including adding and/or removing ports from itputRemove an existing VLANdeleteFetch information from an existing VLANgetWebhookCreate 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 /domains/ptr/{recordId}get https://core.hivelocity.net/api/v2/domains/ptr/{recordId}