DewaVPS

API Reference

Complete REST API reference for the DewaVPS platform. Browse endpoints by category below.

networks

Get private networksRetrieve a list of your private networks (vswitches).Get detail private networkRetrieve detailed information about a specific private network.Get private network IPsRetrieve the list of IPs assigned within a private network.Create private networkCreate a new private network (vswitch) in the specified location.Update private network gatewayUpdate the gateway for a specific private network.Get private network graphRetrieve the network topology graph data for a private network.Update private network graph positionUpdate the position of a node in the private network topology graph.Get gateway optionsRetrieve the available gateway options for a private network in a location.Get private network optionsRetrieve the available private network options for a location.Get free public network optionsRetrieve the available free public IP addresses for a location.Get public networksRetrieve a paginated list of your reserved public network IP addresses.Create public networkReserve a new public IP address in the specified location.Change instance IPChange which instance a public IP address is assigned to.Update RDNS IPUpdate the reverse DNS record for a public IP address.Delete public networkDelete a reserved public IP address.

pricing

Get available systemsRetrieve the list of available operating systems and their versions.Get locationsRetrieve the list of available data center locations.Get tiersRetrieve the list of available compute tiers for a location.Get tier pricingRetrieve the pricing details for a specific compute tier.Get instance size templateRetrieve the predefined instance size templates.

instance

Get all instancesRetrieve a paginated list of all your virtual machine instances.Create instanceCreate a new virtual machine instance with the specified configuration.Get detail instanceRetrieve detailed information about a specific instance.Get RRD dataRetrieve monitoring metrics (CPU, memory, network, disk) for an instance.Clone instanceClone an existing instance to a new instance.Virtual console websocketGet websocket connection details for the virtual console of an instance.Reinstall instanceReinstall the operating system on an instance.Delete instanceTerminate and delete a virtual machine instance.Start instanceStart a stopped instance.Stop instanceStop a running instance.Restart instanceRestart a running instance.Get instances without public IPRetrieve a list of instances that do not have a public IP address assigned.Update private network instanceAttach or detach an instance from a private network (vswitch).Add public network to instanceAdd a public IP address to an instance.Change public network instanceChange or remove the public IP address on an instance.Resize instanceResize the CPU, memory, and storage of an instance.Set password instanceUpdate the root/admin password for an instance.Change tier instanceMigrate an instance to a different compute tier.Get change tier costRetrieve the estimated cost for changing an instance to a different tier.Update hostnameUpdate the hostname of an instance.Get snapshotsRetrieve a list of snapshots for a specific instance.Get snapshot priceRetrieve the estimated monthly price for a snapshot of a specific instance.Create snapshotCreate a new snapshot for a specific instance.Rollback snapshotRollback an instance to a specific snapshot state.Delete snapshotDelete a specific snapshot from an instance.Get backup historiesRetrieve a paginated list of backup histories for a specific instance.Restore backup fileRestore an instance from a specific backup file.Delete backup fileDelete a specific backup file from an instance.Get backup priceRetrieve the estimated backup price for a specific instance.Get backup schedulesRetrieve the list of backup schedules for a specific instance.Create backup scheduleCreate a new backup schedule for a specific instance.Update backup scheduleUpdate the backup schedule for a specific instance.Delete backup scheduleDelete a specific backup schedule from an instance.Get default firewall policyRetrieve the default firewall policy for a specific instance.Get firewall rule typesRetrieve the list of available firewall rule types.Update default firewall policyUpdate the default firewall policy for a specific instance.Get firewall rulesRetrieve a paginated list of firewall rules for a specific instance.Create firewall ruleCreate a new firewall rule for a specific instance.Update firewall ruleUpdate an existing firewall rule for a specific instance.Toggle firewall rule statusEnable or disable a specific firewall rule.Delete firewall ruleDelete a specific firewall rule from an instance.Get IPSetsRetrieve a paginated list of IPSets for a specific instance.Create IPSetCreate a new IPSet for a specific instance.Delete IPSetDelete a specific IPSet from an instance.Create CIDR in IPSetAdd a new CIDR entry to a specific IPSet.Delete CIDR from IPSetRemove a specific CIDR entry from an IPSet.Get SSH keys for instanceRetrieve the list of SSH keys assigned to a specific instance.

block storage

Get block storage typesRetrieve the available block storage types for a specific location.Get my block storagesRetrieve a paginated list of your block storages, filtered by location and instance.Create block storageCreate a new block storage volume in a specific location.Attach block storageAttach a block storage volume to a specific instance.Detach block storageDetach a block storage volume from its current instance.Resize block storageResize a block storage volume to a new size.Delete block storageDelete a specific block storage volume.Get available block storagesRetrieve a list of available (non-attached) block storages for a specific location.

credentials

Get SSH keysRetrieve all your SSH keys.Create SSH keyCreate a new SSH key credential.Delete SSH keyDelete a specific SSH key credential.Get SSH key optionsRetrieve a simplified list of SSH keys for selection.Get unassigned SSH keysRetrieve SSH keys that are not assigned to a specific instance.

billings

Get monthly summaryRetrieve the current month billing summary including balance, costs, and estimates.Get deposit historyRetrieve a paginated list of deposit (top-up) transactions.Export deposit historyExport deposit history as a downloadable file for a given date range.Get deposit detailRetrieve details of a specific deposit transaction.Get credit historyRetrieve a paginated list of credit transactions (additions and deductions).Get postpaid summaryRetrieve the postpaid billing summary including paid and unpaid totals.Get postpaid invoicesRetrieve a paginated list of postpaid invoices.Download invoiceDownload an invoice as a file (PDF).Get payment methodsRetrieve available payment methods grouped by category, with fees calculated for a given amount.Create invoice paymentCreate a new top-up invoice with the specified amount and payment method.Get report summaryRetrieve a paginated list of billing report summaries.Get report summary detailRetrieve detailed billing breakdown for a specific billing period.Export service usageExport the service usage report for a specific billing summary as a downloadable file.