Skip to main content

DewaVPS API (1.0.0)

Download OpenAPI specification:Download

Welcome to the DewaVPS API documentation. This API enables you to efficiently create and manage instances, handle billing operations, configure networking, and perform other essential administrative tasks.

Instance

The Pricing API provides endpoints to retrieve detailed pricing information for various Dewavps services, enabling accurate cost estimation and billing management.

Get instance size template

This endpoint retrieves a RRD data.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "message": "VM size templates",
  • "data": [
    ]
}

Get all instances

This endpoint retrieves all instances.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Limit response data instance.

page
integer

Number of page.

search
string

Search by hostname.

sort
string

Sort by created_at or cost.

statuses
string

Filter by instance status.

Responses

Response samples

Content type
application/json
{
  • "message": "Virtual machines list",
  • "data": {
    }
}

Create instance

This endpoint create virtual machine.

Authorizations:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
required
location_id
required
integer

Id of location.

tier_id
required
integer

Id of tier.

template_id
required
integer

Id of template.

hostname
required
string

Hostname of instance.

cpu
required
integer

Cpu of instance

memory
required
integer

Memory of instance

storage
required
integer

Storage of instance

username
required
string

Username of instance

password
required
string

Password of instance

use_public_ip
required
boolean

Public Network of instance

use_shared_cpu
boolean or null

Shared cpu of instance

vswitch
string or null

Vswitch of instance

ssh_keys
Array of strings or null

SSH Keys of instance

use_dedicated_cpu
boolean or null

Dedictated cpu of instance

include_backup
boolean or null

Backup of instance

public_network
string or null <uuid>

UUID Public Network of instance

Responses

Response samples

Content type
application/json
{
  • "message": "Vm berhasil dibuat",
  • "data": {
    }
}

Get detail instance

This endpoint retrieves a detail instance.

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Virtual machine details",
  • "data": {
    }
}

Get RRD data

This endpoint retrieves a RRD data.

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

query Parameters
periode
required
string

Defines interval RRD data

Responses

Response samples

Content type
application/json
{
  • "message": "RRD data",
  • "data": {
    }
}

Clone instance

Clone instances

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
hostname
required
string

Hostname of instance.

location_id
required
integer

Id of location.

tier_id
required
integer

Id of tier.

Responses

Response samples

Content type
application/json
{
  • "message": "Instance is on cloning progress",
  • "data": {
    }
}

Virtual console websocket

Virtual console websocket

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "VNC connection",
  • "data": {
    }
}

Reinstall instance

Reinstall instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Reinstall process on VM instance",
  • "data": {
    }
}

Delete instance

Delete instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
remove_ip
required
boolean

Specifies whether to remove the Public Network or not.

remove_block_storage
required
boolean

Specifies whether to remove the block storage or not.

_method
required
string

Define delete http method.

Responses

Response samples

Content type
application/json
{
  • "message": "Virtual machine is on terminating process",
  • "data": [
    ]
}

Start instance

Start instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Start process on instance",
  • "data": {
    }
}

Stop instance

Stop instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Stop process on vm instance",
  • "data": {
    }
}

Restart instance

Restart instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Restart process on VM instance",
  • "data": {
    }
}

Get options

This endpoint retrieves options.

Authorizations:
ApiKeyAuth
query Parameters
location_id
required
integer

Defines which location id to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Instance options with no public network",
  • "data": [
    ]
}

Update RDNS IP instance

Update RDNS IP of instance

Authorizations:
ApiKeyAuth
path Parameters
ip_uuid
required
string <uuid>

Defines which ip to retrieve

Request Body schema: application/x-www-form-urlencoded
required
rdns
required
string

RDNS of ip

Responses

Response samples

Content type
application/json
{
  • "message": "RDNS successfully updated",
  • "data": "testajabro.id"
}

Update private network instance

Update private network instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
vswitch
required
string <uuid>

UUID of vswitch

Responses

Response samples

Content type
application/json
{
  • "message": "Instance successfully detached from Private Network",
  • "data": {
    }
}

Add public network instance

Add public network instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Public Network Address successfully added to the instance",
  • "data": {
    }
}

Change public network instance

Change public network instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
public_network
string or null <uuid>

Specifies the Public Network to be modified; leave blank if removal is desired.

Responses

Response samples

Content type
application/json
{
  • "message": "Instance's Public Network successfully changed.",
  • "data": {
    }
}

Resize instance

Resize instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
cpu
required
integer

Cpu of instance

memory
required
integer

Memory of instance

storage
required
integer

Storage of instance

use_dedicated_cpu
boolean or null

Dedictated Cpu of instance

Responses

Response samples

Content type
application/json
{
  • "message": "Virtual machine is resized successfully",
  • "data": {
    }
}

Set password instance

Set password instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
password
required
string

Password of instance

password_confirmation
required
string

Password confirmation of instance

Responses

Response samples

Content type
application/json
{
  • "message": "Virtual machine password successfully updated",
  • "data": null
}

Change tier instance

Change tier instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
tier_id
required
integer

Id of tier

Responses

Response samples

Content type
application/json
{
  • "message": "Your instance will be migrated in a moment...",
  • "data": {
    }
}

Get change tier cost instance

Get change tier cost instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

query Parameters
tier_id
required
integer

Id of tier

Responses

Response samples

Content type
application/json
{
  • "message": "Estimated change tier cost",
  • "data": {
    }
}

Update hostname

Update hostname

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
hostname
required
string

Hostname of instance

Responses

Response samples

Content type
application/json
{
  • "message": "Hostname successfully updated",
  • "data": {
    }
}

Get snapshots instance

Get snapshots instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Instance",
  • "data": [
    ]
}

Get price snapshots instance

Get price snapshots instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

query Parameters
tier_id
required
integer

Id of tier

Responses

Response samples

Content type
application/json
{
  • "message": "Estimated snapshot price per month",
  • "data": {
    }
}

Create snapshot instance

Create snapshot instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
name
required
string

Name of snapshots

description
required
string

Description of snapshots

Responses

Response samples

Content type
application/json
{
  • "message": "Creating snapshot...",
  • "data": {
    }
}

Rollback snapshot instance

Rollback snapshot instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

snapshot_uuid
required
string <uuid>

Defines which snapshot to rollback

Responses

Response samples

Content type
application/json
{
  • "message": "Rollback successfully executed. You can start your instance up.",
  • "data": {
    }
}

Delete snapshot instance

Delete snapshot instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

snapshot_uuid
required
string <uuid>

Defines which snapshot to delete

Responses

Response samples

Content type
application/json
{
  • "message": "Removing snapshot...",
  • "data": {
    }
}

Get backup histories instance

Get backup histories instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

query Parameters
limit
integer

Limit response data instance.

page
integer

Number of page.

Responses

Response samples

Content type
application/json
{
  • "message": "Instance backup schedules",
  • "data": {
    }
}

Delete backup file instance

Delete backup file instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

snapshot_uuid
required
string <uuid>

Defines which snapshot to delete

Responses

Response samples

Content type
application/json
{
  • "message": "Backup file successfully removed.",
  • "data": {
    }
}

Get backup price instance

Get backup price instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

query Parameters
tier_id
required
integer

Id of tier

Responses

Response samples

Content type
application/json
{
  • "message": "Estimated per backup price",
  • "data": {
    }
}

Get backup schedules instance

Get backup schedules instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Instance backup schedules",
  • "data": [
    ]
}

Create backup schedules instance

Create backup schedules instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Backup schedule successfully created",
  • "data": {
    }
}

Update backup schedule instance

Update backup schedule instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
retention
required
integer

Retention of schedule

schedule_on
integer or null

Schedule on

schedule_at
required
integer

When schedule

Responses

Response samples

Content type
application/json
{
  • "message": "Backup schedule successfully updated",
  • "data": {
    }
}

Delete backup schedules instance

Delete backup schedules instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

backup_id
required
integer

Defines which backup to delete

Responses

Response samples

Content type
application/json
{
  • "message": "Backup schedule successfully removed",
  • "data": {
    }
}

Add public network instance

Add public network instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Default network firewall policy",
  • "data": {
    }
}

Delete firewall rules type instance

Delete firewall rules type instance

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Firewall rule types",
  • "data": [
    ]
}

Update default firewall instance

Update default firewall instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
action
required
string

Action of firewall

Responses

Response samples

Content type
application/json
{
  • "message": "Default firewall policy successfully updated",
  • "data": {
    }
}

Get firewall rules instance

Get firewall rules instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

query Parameters
limit
integer

Limit response data firewall.

page
integer

Number of page.

Responses

Response samples

Content type
application/json
{
  • "message": "Instance firewall ruels",
  • "data": {
    }
}

Create firewall instance

Create firewall instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
source_ipset
required
integer

Source ipset of firewall

destination_port
required
integer

Destination port of firewall

action
required
string

Action of firewall

protocol
required
string

Protocol of firewall

description
required
string

Description of firewall

use_ipset
required
boolean

Is using ipset of firewall

Responses

Response samples

Content type
application/json
{
  • "message": "Firewall rule successfully created.",
  • "data": {
    }
}

Update firewall instance

Update firewall instance

path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

firewall_rule_id
required
string <uuid>

Defines which firewall to update

Request Body schema: application/x-www-form-urlencoded
required
destination_port
required
integer

Destination port of firewall

action
required
string

Action of firewall

protocol
required
string

Protocol of firewall

description
required
string

Description of firewall

Responses

Response samples

Content type
application/json
{
  • "message": "Firewall rule successfully updated",
  • "data": {
    }
}

Update status firewall instance

Update status firewall instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

firewall_rule_id
required
string <uuid>

Defines which firewall to update

Request Body schema: application/x-www-form-urlencoded
required
action
required
string

Action of firewall

Responses

Response samples

Content type
application/json
{
  • "message": "Rule successfully enabled",
  • "data": {
    }
}

Delete firewall instance

Delete firewall instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

firewall_uuid
required
string <uuid>

Defines which firewall to delete

Responses

Response samples

Content type
application/json
{
  • "message": "Firewall rule successfully deleted",
  • "data": null
}

Get ipset instance

Get ipset instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

query Parameters
limit
integer

Limit response data ipset.

page
integer

Number of page.

Responses

Response samples

Content type
application/json
{
  • "message": "Instance IPSets",
  • "data": {
    }
}

Create ipset instance

Create ipset instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Request Body schema: application/x-www-form-urlencoded
required
name
required
string

Name of ipset

description
required
string

Description of ipset

Responses

Response samples

Content type
application/json
{
  • "message": "IPSet successfully created",
  • "data": {
    }
}

Delete ipset instance

Delete ipset instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

ipset_id
required
integer

Defines which ipset to delete

Responses

Response samples

Content type
application/json
{
  • "message": "IPSet successfully deleted",
  • "data": null
}

Create CIDR ipset instance

Create CIDR ipset instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

ipset_id
required
integer

Defines which ipset to create cidr

Request Body schema: application/x-www-form-urlencoded
required
cidr
required
string

CIDR of IPSet

description
required
string

Description of CIDR

Responses

Response samples

Content type
application/json
{
  • "message": "IP/CIDR for IPSet successfully created",
  • "data": {
    }
}

Delete CIDR ipset instance

Delete CIDR ipset instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

ipset_id
required
integer

Defines which ipset to delete

iplist_id
required
string <uuid>

Defines which iplist to delete

Responses

Response samples

Content type
application/json
{
  • "message": "IP/CIDR of IPSet successfully deleted",
  • "data": null
}

Get SSH keys instance

Get SSH keys instance

Authorizations:
ApiKeyAuth
path Parameters
instance_uuid
required
string <uuid>

Defines which instance to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "VM",
  • "data": [
    ]
}

Networks

The Network API allows you to manage and configure private networks and virtual switches within the Dewavps platform. Use these endpoints to create, list, and modify network resources securely and efficiently

Get private networks

Retrieves a list of private virtual switches (networks).

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Your Private Network",
  • "data": [
    ]
}

Get detailed information of private network

Retrieves detailed information about a specific virtual switch (private network).

Authorizations:
ApiKeyAuth
path Parameters
vswitch_uuid
required
string <uuid>

Defines which vswitch to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Private Network details",
  • "data": {
    }
}

Retrieve private network IPs

Get a list of private IP addresses assigned to VMs within a specific VSwitch.

Authorizations:
ApiKeyAuth
path Parameters
vswitch_id
required
string

Specifies which VSwitch to fetch IPs for.

Responses

Response samples

Content type
application/json
{
  • "message": "Private Network ips",
  • "data": {
    }
}

Create private network

Creates a new private virtual network.

Authorizations:
ApiKeyAuth
query Parameters
name
required
string
Example: name=Local switch 1

Name of private network

location_id
required
integer
Example: location_id=1

ID of location

Responses

Response samples

Content type
application/json
{
  • "message": "Private Network will be created in a moment",
  • "data": {
    }
}

Update private network gateway

Updates the public gateway of a private virtual network switch.

Authorizations:
ApiKeyAuth
path Parameters
vswitch_uuid
required
string <uuid>

Defines which vswitch to update

header Parameters
x-apikey
required
string

API key for authentication

Request Body schema: application/json
required
public_gateway
required
string

Public gateway of Private Network

Responses

Request samples

Content type
application/json
{
  • "public_gateway": "0f0415fa-ed50-49c5-ab7a-b9df1a091c05"
}

Response samples

Content type
application/json
{
  • "message": "Private Network Gateway updated successfully",
  • "data": {
    }
}

Get private network graph

Retrieves the graph data of a private network switch.

Authorizations:
ApiKeyAuth
path Parameters
vswitch_id
required
integer <int64>

Defines which graph vswitch to retrieve

header Parameters
x-apikey
required
string

API key for authentication

Responses

Response samples

Content type
application/json
{
  • "message": "Private Network graph data",
  • "data": {
    }
}

Get private network gateway

Get private network gateway

Authorizations:
ApiKeyAuth
query Parameters
location_id
required
integer <int64>

Id of location

vswitch_uuid
required
string <uuid>

UUID of private network

Responses

Response samples

Content type
application/json
{
  • "message": "Your Private Networkes",
  • "data": [
    ]
}

Get private network options

Get private network options

Authorizations:
ApiKeyAuth
query Parameters
location_id
required
integer <int64>

Id of location

Responses

Response samples

Content type
application/json
{
  • "message": "Your Private Networks",
  • "data": [
    ]
}

Get free public network options

Get free public network options

Authorizations:
ApiKeyAuth
query Parameters
location_id
required
integer <int64>

Id of location

Responses

Response samples

Content type
application/json
{
  • "message": "Public Network Options",
  • "data": [
    ]
}

Get public network

Get public network

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Limit response data instance.

page
integer

Number of page.

Responses

Response samples

Content type
application/json
{
  • "message": "Public Network",
  • "data": {
    }
}

Create public network

Create public network

Authorizations:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
required
location_id
required
integer <int64>

Id of location

Responses

Response samples

Content type
application/json
{
  • "message": "Public Network successfully created",
  • "data": {
    }
}

Change instance IP

Change instance IP

Authorizations:
ApiKeyAuth
path Parameters
ip_uuid
required
string <uuid>

Defines which ip to retrieve

Request Body schema: application/x-www-form-urlencoded
required
instance_id
required
string <uuid>

UUID of instance that want to update IP

Responses

Response samples

Content type
application/json
{
  • "message": "Public network instance successfully removed.",
  • "data": [
    ]
}

Update RDNS IP

Update RDNS IP

Authorizations:
ApiKeyAuth
path Parameters
ip_uuid
required
string <uuid>

Defines which ip to retrieve

Request Body schema: application/x-www-form-urlencoded
required
rdns
required
string

RDNS of ip

Responses

Response samples

Content type
application/json
{
  • "message": "RDNS successfully updated",
  • "data": "testajabro.id"
}

Delete public network

Delete public network

Authorizations:
ApiKeyAuth
path Parameters
ip_uuid
required
string <uuid>

Defines which ip to delete

Responses

Response samples

Content type
application/json
{
  • "message": "Public Network successfully removed",
  • "data": {
    }
}

Block Storage

The Block Storage API enables management of block storage volumes, allowing you to create, attach, detach, and delete volumes for your virtual instances efficiently and securely.

Get blocks types

This endpoint retrieves block storage type.

Authorizations:
ApiKeyAuth
query Parameters
location_id
required
integer

Id of location.

Responses

Response samples

Content type
application/json
{
  • "message": "Block storage types",
  • "data": [
    ]
}

Get my block storages

This endpoint retrieves my block storages.

Authorizations:
ApiKeyAuth
query Parameters
location_id
required
integer

Id of location.

instance_id
required
string <uuid>

Defines which instance to retrieve.

Responses

Response samples

Content type
application/json
{
  • "message": "My block storages",
  • "data": {
    }
}

Attach block storage

This endpoint attach block storage.

Authorizations:
ApiKeyAuth
path Parameters
block_storage_id
required
integer

Id of block storage

Request Body schema: application/x-www-form-urlencoded
required
instance_id
required
string <uuid>

Defines which instance to attach block storage

Responses

Response samples

Content type
application/json
{
  • "type": "INVALID_OPERATION",
  • "message": "Block storage already attached to an instance"
}

Detach block storage

This endpoint detach block storage.

Authorizations:
ApiKeyAuth
path Parameters
block_storage_id
required
integer

Id of block storage

Responses

Response samples

Content type
application/json
{
  • "type": "INVALID_OPERATION",
  • "message": "Block storage is not attached to any instance"
}

Resize block storage

This endpoint resize block storage.

Authorizations:
ApiKeyAuth
path Parameters
block_storage_id
required
integer

Id of block storage

Request Body schema: application/x-www-form-urlencoded
required
size
required
integer

Size of storage

Responses

Response samples

Content type
application/json
{
  • "message": "Block storage successfully resized",
  • "data": {
    }
}

Delete block storage

This endpoint delete block storage.

Authorizations:
ApiKeyAuth
path Parameters
block_storage_id
required
integer

Id of block storage

Responses

Response samples

Content type
application/json
{
  • "message": "Block storage successfully removed",
  • "data": {
    }
}

Get available blocks

This endpoint Get available non attached block storages.

Authorizations:
ApiKeyAuth
query Parameters
location_id
required
integer

Id of location.

Responses

Response samples

Content type
application/json
{
  • "message": "Available non-attached block storage",
  • "data": [
    ]
}

Credential

The Credential API manages authentication credentials such as SSH keys and passwords. It allows you to securely create, store, retrieve, and delete credentials used for accessing virtual instances.

Get SSH

Get SSH

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "message": "My SSH Key",
  • "data": [
    ]
}

Create SSH

Create SSH

Authorizations:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
required
title
required
string

Title of ssh

key
required
string

Public key of ssh

Responses

Response samples

Content type
application/json
{
  • "message": "SSH Key successfully created",
  • "data": {
    }
}

Delete SSH

Delete SSH

Authorizations:
ApiKeyAuth
path Parameters
ssh_id
required
string

SSH ID to delete

Responses

Response samples

Content type
application/json
{
  • "message": "SSH key successfully deleted",
  • "data": {
    }
}

Get SSH options

Get SSH options

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "message": "SSH key options",
  • "data": [
    ]
}

Pricing

The Pricing API provides endpoints to retrieve detailed pricing information for various services and resources offered by Dewavps. Use this API to access up-to-date pricing data to facilitate budgeting and cost management.

Get available systems

Get available systems

Authorizations:
ApiKeyAuth
query Parameters
location
integer <int64>

Id of location

Responses

Response samples

Content type
application/json
{
  • "message": "Available Systems",
  • "data": [
    ]
}

Get locations

Get locations

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Daftar lokasi data center",
  • "data": [
    ]
}

Get tiers

Get tiers

Authorizations:
ApiKeyAuth
query Parameters
location_id
integer <int64>

Id of location

Responses

Response samples

Content type
application/json
{}

Get tier pricing

Get tier pricing

Authorizations:
ApiKeyAuth
path Parameters
tier_id
required
integer <int64>

Id of tier

Responses

Response samples

Content type
application/json
{
  • "message": "Pricing list",
  • "data": [
    ]
}

Billing

The Billing API provides access to billing-related functionalities, allowing you to retrieve invoices, manage payment methods, and obtain detailed billing history for your Dewavps account.

Get Monthly Summary

Retrieves the monthly billing summary.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "message": "This month summary",
  • "data": {
    }
}

Get Deposit History

Retrieves the history of deposits.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Limit response data deposit history.

page
integer

Number of page.

Responses

Response samples

Content type
application/json
{
  • "message": "Deposit Histories",
  • "data": [
    ],
  • "pagination": {
    }
}

Initiate the export of deposit history.

Triggers the process to export the deposit history based on specified criteria.

Authorizations:
ApiKeyAuth
query Parameters
start
string <date>

Start of data.

end
string <date>

End of date.

Responses

Response samples

Content type
application/json
{
  • "message": "Exporting deposit history",
  • "data": {
    }
}

Retrieve detailed information for a specific deposit.

Fetches the detailed information of a deposit based on the provided invoice ID.

Authorizations:
ApiKeyAuth
path Parameters
invoice_id
required
string

Defines which invoice to retrieve.

Responses

Response samples

Content type
application/json
{}

Retrieve the history of credit transactions.

Fetches a list of all credit transactions made.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Limit response data deposit history.

page
integer

Number of page.

start
string <date>

Start of data.

end
string <date>

End of date.

type
string

A (add) or D (deduct).

Responses

Response samples

Content type
application/json
{
  • "message": "credit history",
  • "data": [
    ],
  • "pagination": {
    }
}

Retrieve the monthly summary for postpaid billing.

Fetches a summary of the postpaid billing information for the current month.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Postpaid customer billing summary",
  • "data": {
    }
}

Retrieve monthly postpaid invoices.

Fetches a list of postpaid invoices for the current month.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Your invoices",
  • "data": {
    }
}

Download a specific invoice.

Initiates the download of an invoice identified by its unique ID.

Authorizations:
ApiKeyAuth
path Parameters
invoice_id
required
string

Defines which invoice to retrieve.

Responses

Get available payment methods.

Retrieves a list of available payment methods.

Authorizations:
ApiKeyAuth
query Parameters
amount
integer

Amount of payment methods.

Responses

Response samples

Content type
application/json
{}

Create invoice payment.

Creates an invoice payment.

Authorizations:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
required
amount
required
integer

Amount of payment.

payment_method
required
string

Payment method of payment.

Responses

Response samples

Content type
application/json
{
  • "message": "Invoice created",
  • "data": {}
}

Get report summary.

Retrieves a summary of the billing report.

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Limit response data deposit history.

page
integer

Number of page.

Responses

Response samples

Content type
application/json
{
  • "message": "Summary billing report",
  • "data": {
    }
}

Get summary detail.

Defines which invoice to retrieve.

Authorizations:
ApiKeyAuth
path Parameters
summary_date
required
string <date>

Defines which invoice to retrieve

Responses

Response samples

Content type
application/json
{
  • "message": "Billing report for 337fc06d-d85f-4cd0-acc8-4b497831e1dd",
  • "data": {
    }
}

Export service usage.

Defines which summary to export.

Authorizations:
ApiKeyAuth
path Parameters
summary_id
required
string

Defines which summary to export

Responses

Response samples

Content type
application/json
{
  • "message": "Exporting summary data",
  • "data": {
    }
}