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.
The Pricing API provides endpoints to retrieve detailed pricing information for various Dewavps services, enabling accurate cost estimation and billing management.
Response samples
- 200
{- "message": "VM size templates",
- "data": [
- {
- "id": 1,
- "title": "Starter",
- "total_cpu": 1,
- "total_ram": 1,
- "total_disk": 30,
- "created_at": "2023-01-27T02:42:31.000000Z",
- "updated_at": "2023-01-27T02:42:31.000000Z"
}, - {
- "id": 2,
- "title": "Exploring",
- "total_cpu": 1,
- "total_ram": 2,
- "total_disk": 50,
- "created_at": "2023-01-27T02:42:31.000000Z",
- "updated_at": "2023-01-27T02:42:31.000000Z"
}
]
}Get all instances
This endpoint retrieves all instances.
Authorizations:
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
- 200
{- "message": "Virtual machines list",
- "data": {
- "data": [
- {
- "uuid": "7995e990-c3bf-4e27-8ce2-89fd5783f9ea",
- "hostname": "test-bagas",
- "ip_address": null,
- "cpu": 2,
- "memory": "2 GB",
- "storage": "30GB",
- "status": "Running",
- "location": "Jakarta 1",
- "tier": "Cloud Compute AMD Epyc",
- "price_per_hour": 327,
- "estimated_monthly_cost": 235440,
- "cost": null,
- "operation_flag": 0,
- "created_at": "25 January 2024, 14:43"
}
], - "active_operation": 0,
- "page": {
- "total": 2,
- "count": 2,
- "per_page": 10,
- "current_page": 1,
- "total_pages": 1
}
}
}Create instance
This endpoint create virtual machine.
Authorizations:
Request Body schema: application/x-www-form-urlencodedrequired
| 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
- 200
{- "message": "Vm berhasil dibuat",
- "data": {
- "uuid": "5bacdb5e-175e-4199-b255-b1c7e595610d",
- "hostname": "not-so-seriues-test-local-4",
- "node_id": 2,
- "cpu": 1,
- "memory": 2,
- "storage": 10,
- "status": "creating",
- "username": "root",
- "active_price_per_min": 7.00823,
- "inactive_price_per_min": 4.91832,
- "template_id": 1,
- "billing_id": 70,
- "customer_id": 2,
- "updated_at": "2022-01-05T03:39:56.000000Z",
- "created_at": "2022-01-05T03:39:56.000000Z",
- "id": 67
}
}Get detail instance
This endpoint retrieves a detail instance.
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "Virtual machine details",
- "data": {
- "uuid": "7995e990-c3bf-4e27-8ce2-89fd5783f9ea",
- "hostname": "test-bagas",
- "username": "root",
- "cpu": "2 CPU",
- "is_cpu_dedicated": true,
- "memory": "2048 MB",
- "storage": "30 GB",
- "status": "Running",
- "os_name": "Ubuntu 18.04",
- "public_ip": {
- "ip_id": "-",
- "ip_address": "-"
}, - "rdns": "-",
- "private_network": "-",
- "location_id": 1,
- "location": "Jakarta 1",
- "tier_id": 4,
- "tier": "Cloud Compute AMD Epyc",
- "os": {
- "template_id": 22,
- "version": 18.04,
- "os_id": 6,
- "name": "Ubuntu",
- "min_cpu": 1,
- "min_memory": 1,
- "min_storage": 20
}, - "price_per_hour": 327,
- "estimated_monthly_price": 235440,
- "cost": null,
- "operation_flag": 0,
- "created_at": "25-01-2024 14:43:18",
- "updated_at": "27-08-2024 11:28:13",
- "last_started_at": "27-08-2024 11:26:37",
- "last_backup_at": null
}
}Get RRD data
This endpoint retrieves a RRD data.
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
query Parameters
| periode required | string Defines interval RRD data |
Responses
Response samples
- 200
{- "message": "RRD data",
- "data": {
- "cpu": [
- {
- "time": "2023-01-24 15:31",
- "cpu": 0.0139689919472582
}
], - "memory": [
- {
- "time": "2023-01-24 15:31",
- "raw_max_memory": 4294967296,
- "max_memory": "4.29 GB",
- "raw_usage_memory": 561891601.066667,
- "usage_memory": "561.89 MB"
}
], - "network": [
- {
- "time": "2023-01-24 15:31",
- "raw_netin": 82.2,
- "netin": "82 B",
- "raw_netout": 13,
- "netout": "13 B"
}
], - "disk": [
- {
- "time": "2023-01-24 15:31",
- "raw_diskwrite": 16725.3333333333,
- "diskwrite": "16.73 KB",
- "raw_diskread": 0,
- "diskread": "0 B"
}
]
}
}Clone instance
Clone instances
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| hostname required | string Hostname of instance. |
| location_id required | integer Id of location. |
| tier_id required | integer Id of tier. |
Responses
Response samples
- 200
{- "message": "Instance is on cloning progress",
- "data": {
- "uuid": "43bdc333-877b-4bcd-bc91-45da2104499f"
}
}Virtual console websocket
Virtual console websocket
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "VNC connection",
- "data": {
- "url": "wss://dc1-wss.maxstage.id?t=66CD82FE%3A%3AN4AhOORFs9tqLE1NWeo...",
- "password": "U#@^@.0*"
}
}Reinstall instance
Reinstall instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "Reinstall process on VM instance",
- "data": {
- "uuid": "19c881bb-c1a6-4ec7-b303-8b08c1abe5d0",
- "hostname": "loc-11111"
}
}Delete instance
Delete instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| 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
- 200
{- "message": "Virtual machine is on terminating process",
- "data": [
- {
- "uuid": "e688866c-deeb-4e55-85cc-1c24fb2f1a71",
- "hostname": "local-666-2"
}
]
}Start instance
Start instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "Start process on instance",
- "data": {
- "uuid": "630d7152-1595-4014-a052-a49b647e58c1",
- "hostname": "local-321"
}
}Stop instance
Stop instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "Stop process on vm instance",
- "data": {
- "uuid": "19c881bb-c1a6-4ec7-b303-8b08c1abe5d0",
- "hostname": "loc-11111"
}
}Restart instance
Restart instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "Restart process on VM instance",
- "data": {
- "uuid": "19c881bb-c1a6-4ec7-b303-8b08c1abe5d0",
- "hostname": "loc-11111"
}
}Get options
This endpoint retrieves options.
Authorizations:
query Parameters
| location_id required | integer Defines which location id to retrieve |
Responses
Response samples
- 200
{- "message": "Instance options with no public network",
- "data": [
- {
- "id": "4c657c65-1696-487e-9154-6992fab3818d",
- "hostname": "local-666-6"
}
]
}Update RDNS IP instance
Update RDNS IP of instance
Authorizations:
path Parameters
| ip_uuid required | string <uuid> Defines which ip to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| rdns required | string RDNS of ip |
Responses
Response samples
- 200
{- "message": "RDNS successfully updated",
- "data": "testajabro.id"
}Update private network instance
Update private network instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| vswitch required | string <uuid> UUID of vswitch |
Responses
Response samples
- 200
{- "message": "Instance successfully detached from Private Network",
- "data": {
- "vm_uuid": "7cf4a61d-ec47-4f87-a5af-fcab076f4fab"
}
}Add public network instance
Add public network instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "Public Network Address successfully added to the instance",
- "data": {
- "vm_uuid": "a5d1836a-96b1-4144-bf4f-108ec6df5abe",
- "ip_address": "192.168.1.221"
}
}Change public network instance
Change public network instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| public_network | string or null <uuid> Specifies the Public Network to be modified; leave blank if removal is desired. |
Responses
Response samples
- 200
{- "message": "Instance's Public Network successfully changed.",
- "data": {
- "instance": "8c8e8723-625b-4b33-b279-6ae155dace95",
- "public_ip": "192.168.1.203"
}
}Resize instance
Resize instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| 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
- 200
{- "message": "Virtual machine is resized successfully",
- "data": {
- "uuid": "44e9de1f-576b-4e35-9c78-3d0535a549a8",
- "hostname": "updated-hostname-666"
}
}Set password instance
Set password instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| password required | string Password of instance |
| password_confirmation required | string Password confirmation of instance |
Responses
Response samples
- 200
{- "message": "Virtual machine password successfully updated",
- "data": null
}Change tier instance
Change tier instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| tier_id required | integer Id of tier |
Responses
Response samples
- 200
{- "message": "Your instance will be migrated in a moment...",
- "data": {
- "vm_uuid": "a5d1836a-96b1-4144-bf4f-108ecd6f5abe"
}
}Get change tier cost instance
Get change tier cost instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
query Parameters
| tier_id required | integer Id of tier |
Responses
Response samples
- 200
{- "message": "Estimated change tier cost",
- "data": {
- "current_monthly_cost": 315000.0432,
- "estimated_new_monthly_cost": 285000.048
}
}Update hostname
Update hostname
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| hostname required | string Hostname of instance |
Responses
Response samples
- 200
{- "message": "Hostname successfully updated",
- "data": {
- "uuid": "44e9de1f-576b-4e35-9c78-3d0535a549a8",
- "hostname": "updated-hostname-666"
}
}Get snapshots instance
Get snapshots instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "Instance",
- "data": [
- {
- "id": "4a940301-d309-4866-8d84-1a38775df3fa",
- "name": "test_2712231035",
- "description": "Lupa buat apa",
- "status": "Error",
- "current_hourly_price": null,
- "current_cost": null,
- "estimated_monthly": null,
- "is_current_state": false,
- "attached_storage": [ ],
- "created_at": "15 August 2024 10:31"
}
]
}Get price snapshots instance
Get price snapshots instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
query Parameters
| tier_id required | integer Id of tier |
Responses
Response samples
- 200
{- "message": "Estimated snapshot price per month",
- "data": {
- "price_per_month": 33600
}
}Create snapshot instance
Create snapshot instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| name required | string Name of snapshots |
| description required | string Description of snapshots |
Responses
Response samples
- 200
{- "message": "Creating snapshot...",
- "data": {
- "snap_uuid": "799f17dc-d1b2-4ca8-b733-c113d2db1fba"
}
}Rollback snapshot instance
Rollback snapshot instance
Authorizations:
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
- 200
{- "message": "Rollback successfully executed. You can start your instance up.",
- "data": {
- "uuid": "e48cbbdd-4428-4302-ac7b-183ad9d73a6d"
}
}Delete snapshot instance
Delete snapshot instance
Authorizations:
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
- 200
{- "message": "Removing snapshot...",
- "data": {
- "vm_uuid": "630d7152-1595-4014-a052-a49b647e58c1",
- "snap_uuid": "630d7152-1595-4014-a052-a49b647e58c1"
}
}Get backup histories instance
Get backup histories instance
Authorizations:
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
- 200
{- "message": "Instance backup schedules",
- "data": {
- "page": {
- "total": 2,
- "count": 2,
- "per_page": 10,
- "current_page": 1,
- "total_pages": 1
}, - "data": [
- {
- "id": "d975203d-9006-4f67-9084-bfd55c80d15f",
- "schedule": "daily",
- "current_cost": 16.2036,
- "est_this_month": 633.56076,
- "size": 70,
- "created_at": "31 May 2024 10:57",
- "attached_storage": [
- {
- "id": "fefc66f4-38d5-4d84-b1b3-a9311d104548",
- "name": "locpgsql-2",
- "size": 30
}
]
}
]
}
}Delete backup file instance
Delete backup file instance
Authorizations:
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
- 200
{- "message": "Backup file successfully removed.",
- "data": {
- "backup": "4fade578-f8a0-4ad1-bc2c-63ffa23554e0"
}
}Get backup price instance
Get backup price instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
query Parameters
| tier_id required | integer Id of tier |
Responses
Response samples
- 200
{- "message": "Estimated per backup price",
- "data": {
- "storage_size": 30,
- "block_storage_size": 0,
- "price_per_hour": 20.833199999999998,
- "price_per_month": 15000
}
}Get backup schedules instance
Get backup schedules instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "Instance backup schedules",
- "data": [
- {
- "id": "576807e3-6f65-440d-aae1-66dd43bc5929",
- "schedule": {
- "type": "weekly",
- "time": 5,
- "day": 7,
- "description": "Weekly at Saturday 05:00"
}, - "retention": 2,
- "next_backup_at": "18-05-2024 05:00:00",
- "created_at": "16 May 2024 13:05",
- "updated_at": "16 May 2024 13:05"
}
]
}Create backup schedules instance
Create backup schedules instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "Backup schedule successfully created",
- "data": {
- "schedule": "weekly"
}
}Update backup schedule instance
Update backup schedule instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| retention required | integer Retention of schedule |
| schedule_on | integer or null Schedule on |
| schedule_at required | integer When schedule |
Responses
Response samples
- 200
{- "message": "Backup schedule successfully updated",
- "data": {
- "next_run": "14-09-2023 04:00:00"
}
}Delete backup schedules instance
Delete backup schedules instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
| backup_id required | integer Defines which backup to delete |
Responses
Response samples
- 200
{- "message": "Backup schedule successfully removed",
- "data": {
- "backup": "4d852d9a-5f34-422f-8b96-f92a014c32d1",
- "remove_file": true
}
}Add public network instance
Add public network instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "Default network firewall policy",
- "data": {
- "policy_key": "A",
- "policy": "ACCEPT"
}
}Update default firewall instance
Update default firewall instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| action required | string Action of firewall |
Responses
Response samples
- 200
{- "message": "Default firewall policy successfully updated",
- "data": {
- "action": "ACCEPT"
}
}Get firewall rules instance
Get firewall rules instance
Authorizations:
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
- 200
{- "message": "Instance firewall ruels",
- "data": {
- "data": [
- {
- "id": "RmlsQm5WWGZXanRKYkk4aUIzR01Ndz09",
- "source": "0.0.0.0/0",
- "source_ipset": {
- "name": null,
- "cidr": [
- "1.1.1.1",
- "1.1.1.2",
- "1.1.1.3"
]
}, - "destination_port": 24,
- "action": "A",
- "action_desc": "ACCEPT",
- "protocol": "tcp",
- "is_enable": 1,
- "description": "test",
- "created_at": "10-10-2023 09:56:23"
}
], - "page": {
- "total": 2,
- "count": 2,
- "per_page": 10,
- "current_page": 1,
- "total_pages": 1
}
}
}Create firewall instance
Create firewall instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| 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
- 200
{- "message": "Firewall rule successfully created.",
- "data": {
- "description": "test"
}
}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-urlencodedrequired
| 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
- 200
{- "message": "Firewall rule successfully updated",
- "data": {
- "id": "bVVJKzduR292RG"
}
}Update status firewall instance
Update status firewall instance
Authorizations:
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-urlencodedrequired
| action required | string Action of firewall |
Responses
Response samples
- 200
{- "message": "Rule successfully enabled",
- "data": {
- "id": "bVVJKzduR292RG9IZThaTExwZG9TZz09"
}
}Delete firewall instance
Delete firewall instance
Authorizations:
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
- 200
{- "message": "Firewall rule successfully deleted",
- "data": null
}Get ipset instance
Get ipset instance
Authorizations:
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
- 200
{- "message": "Instance IPSets",
- "data": {
- "data": [
- {
- "id": 2,
- "name": "test_ipset",
- "description": "test",
- "iplist": [
- {
- "id": 3,
- "cidr": "1.1.1.1",
- "description": "Test IP for IPSet"
}
]
}
], - "page": {
- "total": 1,
- "count": 1,
- "per_page": 3,
- "current_page": 1,
- "total_pages": 1
}
}
}Create ipset instance
Create ipset instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| name required | string Name of ipset |
| description required | string Description of ipset |
Responses
Response samples
- 200
{- "message": "IPSet successfully created",
- "data": {
- "vm_uuid": "05c792b3-5abb-4fdf-8448-042a5c3868de",
- "ipset": "test_ipset"
}
}Delete ipset instance
Delete ipset instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
| ipset_id required | integer Defines which ipset to delete |
Responses
Response samples
- 200
{- "message": "IPSet successfully deleted",
- "data": null
}Create CIDR ipset instance
Create CIDR ipset instance
Authorizations:
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-urlencodedrequired
| cidr required | string CIDR of IPSet |
| description required | string Description of CIDR |
Responses
Response samples
- 200
{- "message": "IP/CIDR for IPSet successfully created",
- "data": {
- "cidr": "1.1.1.1"
}
}Delete CIDR ipset instance
Delete CIDR ipset instance
Authorizations:
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
- 200
{- "message": "IP/CIDR of IPSet successfully deleted",
- "data": null
}Get SSH keys instance
Get SSH keys instance
Authorizations:
path Parameters
| instance_uuid required | string <uuid> Defines which instance to retrieve |
Responses
Response samples
- 200
{- "message": "VM",
- "data": [
- {
- "id": 2,
- "title": "Macbook Mamah",
- "added_at": "29 June 2023 11:21"
}
]
}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:
Responses
Response samples
- 200
{- "message": "Your Private Network",
- "data": [
- {
- "uuid": "0d805649-9a66-4e0e-8cac-69659b40c2b9",
- "name": "DewaVPS Network App",
- "tag": 1000,
- "location": "Jakarta",
- "network_ip": "10.252.12.0/24",
- "gateway": {
- "uuid": null,
- "hostname": null,
- "private_ip": null
}, - "status": "Active",
- "created_at": "25 January 2024 14:37"
}
]
}Get detailed information of private network
Retrieves detailed information about a specific virtual switch (private network).
Authorizations:
path Parameters
| vswitch_uuid required | string <uuid> Defines which vswitch to retrieve |
Responses
Response samples
- 200
{- "message": "Private Network details",
- "data": {
- "uuid": "0d805649-9a66-4e0e-8cac-69659b40c2b9",
- "name": "Local Ysf 1",
- "tag": 1000,
- "vid": "vloc1000",
- "location": {
- "id": 1,
- "name": "Jakarta 1"
}, - "total_active_instance": 2,
- "status": "Active",
- "gateway": {
- "uuid": null,
- "hostname": null,
- "private_ip": null
}, - "created_at": "25 January 2024 14:37",
- "last_update_at": "25 January 2024 14:38"
}
}Retrieve private network IPs
Get a list of private IP addresses assigned to VMs within a specific VSwitch.
Authorizations:
path Parameters
| vswitch_id required | string Specifies which VSwitch to fetch IPs for. |
Responses
Response samples
- 200
{- "message": "Private Network ips",
- "data": {
- "data": [
- {
- "ip_address": "10.252.12.1",
- "vm_uuid": "fbc28e05-8ba3-4291-ab38-0021e2ae1a2b",
- "hostname": "local-999-1"
}, - {
- "ip_address": "10.252.12.2",
- "vm_uuid": "9eee234a-41ad-4590-827b-ad9ac71a62ce",
- "hostname": "local-999-2"
}
], - "page": {
- "total": 2,
- "count": 2,
- "per_page": 10,
- "current_page": 1,
- "total_pages": 1
}
}
}Create private network
Creates a new private virtual network.
Authorizations:
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
- 200
{- "message": "Private Network will be created in a moment",
- "data": {
- "hv_net": "vGig",
- "network_ip": "10.66.245.0/24"
}
}Update private network gateway
Updates the public gateway of a private virtual network switch.
Authorizations:
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/jsonrequired
| public_gateway required | string Public gateway of Private Network |
Responses
Request samples
- Payload
{- "public_gateway": "0f0415fa-ed50-49c5-ab7a-b9df1a091c05"
}Response samples
- 200
{- "message": "Private Network Gateway updated successfully",
- "data": {
- "vswitch_uuid": "30994a7c-0523-4432-97f7-1ae577ffa2e6",
- "public_gateway": "0f0415fa-ed50-49c5-ab7a-b9df1a091c05"
}
}Get private network graph
Retrieves the graph data of a private network switch.
Authorizations:
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
- 200
{- "message": "Private Network graph data",
- "data": {
- "nodes": [
- {
- "id": "0d805649-9a66-4e0e-8cac-69659b40c2b9",
- "type": "network",
- "position": {
- "x": 0,
- "y": 0
}, - "data": {
- "vswitch_id": "0d805649-9a66-4e0e-8cac-69659b40c2b9",
- "type": "Network",
- "label": "Khususon Network App",
- "ip": "10.252.12.0/24"
}, - "style": [ ],
- "parent": null,
- "draggable": false
}
], - "edges": [
- {
- "id": "0d805649-9a66-4e0e-8cac-69659b40c2b9->10.252.12.1",
- "source": "0d805649-9a66-4e0e-8cac-69659b40c2b9",
- "target": "10.252.12.1",
- "label": null
}
]
}
}Get private network gateway
Get private network gateway
Authorizations:
query Parameters
| location_id required | integer <int64> Id of location |
| vswitch_uuid required | string <uuid> UUID of private network |
Responses
Response samples
- 200
{- "message": "Your Private Networkes",
- "data": [
- {
- "uuid": "30994a7c-0523-4432-97f7-1ae577ffa2e6",
- "name": "Network App",
- "hv_tag": 1,
- "location": "Jakarta 1",
- "created_at": "19 June 2023 15:51",
- "last_update_at": "19 June 2023 15:51"
}
]
}Get private network options
Get private network options
Authorizations:
query Parameters
| location_id required | integer <int64> Id of location |
Responses
Response samples
- 200
{- "message": "Your Private Networks",
- "data": [
- {
- "uuid": "0d805649-9a66-4e0e-8cac-69659b40c2b9",
- "name": "Local Ysf 1",
- "tag": 1000,
- "location": "Jakarta 1",
- "network_ip": "10.252.12.0/24",
- "gateway": {
- "uuid": null,
- "hostname": null,
- "private_ip": null
}, - "status": "Active",
- "created_at": "25 January 2024 14:37"
}
]
}Get free public network options
Get free public network options
Authorizations:
query Parameters
| location_id required | integer <int64> Id of location |
Responses
Response samples
- 200
{- "message": "Public Network Options",
- "data": [
- {
- "id": "003bbc1a-59cf-4657-8714-4fa0a68ec8d4",
- "ip_address": "192.168.1.200"
}
]
}Get public network
Get public network
Authorizations:
query Parameters
| limit | integer Limit response data instance. |
| page | integer Number of page. |
Responses
Response samples
- 200
{- "message": "Public Network",
- "data": {
- "data": [
- {
- "id": "003bbc1a-59cf-4657-8714-4fa0a68ec8d4",
- "ip_address": "192.168.1.200",
- "instance": {
- "id": "0f0415fa-ed50-49c5-ab7a-b9df1a091c05",
- "hostname": "local-666-1"
}, - "location": {
- "id": 1,
- "name": "Jakarta 1"
}, - "price_per_hour": "34.72222",
- "est_this_month_price": 25000,
- "cost": 10443.28718,
- "created_at": "09-11-2023 13:48:06"
}
], - "page": {
- "total": 2,
- "count": 2,
- "per_page": 10,
- "current_page": 1,
- "total_pages": 1
}
}
}Create public network
Create public network
Authorizations:
Request Body schema: application/x-www-form-urlencodedrequired
| location_id required | integer <int64> Id of location |
Responses
Response samples
- 200
{- "message": "Public Network successfully created",
- "data": {
- "ip_address": "192.168.1.243"
}
}Change instance IP
Change instance IP
Authorizations:
path Parameters
| ip_uuid required | string <uuid> Defines which ip to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| instance_id required | string <uuid> UUID of instance that want to update IP |
Responses
Response samples
- 200
{- "message": "Public network instance successfully removed.",
- "data": [
- {
- "ip_id": "27ed6b76-ee01-4ae4-8173-c4372c080764",
- "instance_id": "4c657c65-1696-487e-9154-6992fab3818d"
}
]
}Update RDNS IP
Update RDNS IP
Authorizations:
path Parameters
| ip_uuid required | string <uuid> Defines which ip to retrieve |
Request Body schema: application/x-www-form-urlencodedrequired
| rdns required | string RDNS of ip |
Responses
Response samples
- 200
{- "message": "RDNS successfully updated",
- "data": "testajabro.id"
}Delete public network
Delete public network
Authorizations:
path Parameters
| ip_uuid required | string <uuid> Defines which ip to delete |
Responses
Response samples
- 200
{- "message": "Public Network successfully removed",
- "data": {
- "ip_id": "33f9cec7-f9c8-4103-a232-1b586116e8bc"
}
}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:
query Parameters
| location_id required | integer Id of location. |
Responses
Response samples
- 200
{- "message": "Block storage types",
- "data": [
- {
- "id": 3,
- "type": "HDD",
- "description": "Affordable, scalable persistent hard disk storage.",
- "price_per_hour": 2.77778,
- "price_per_month": 2000.0016
}
]
}Get my block storages
This endpoint retrieves my block storages.
Authorizations:
query Parameters
| location_id required | integer Id of location. |
| instance_id required | string <uuid> Defines which instance to retrieve. |
Responses
Response samples
- 200
{- "message": "My block storages",
- "data": {
- "data": [
- {
- "id": "41f26dc9-1d11-4ad7-b195-796bcf6ba52d",
- "name": "test-storage-aja",
- "type": "HDD",
- "attached_to": {
- "id": null,
- "hostname": null
}, - "size": 50,
- "size_description": "50GB",
- "status": "ACTIVE",
- "price_per_hour": 138.889,
- "est_this_month_price": 44650,
- "cost": 8981.48874,
- "created_at": "17-11-2023 14:30:39"
}
], - "page": {
- "total": 2,
- "count": 2,
- "per_page": 15,
- "current_page": 1,
- "total_pages": 1
}
}
}Attach block storage
This endpoint attach block storage.
Authorizations:
path Parameters
| block_storage_id required | integer Id of block storage |
Request Body schema: application/x-www-form-urlencodedrequired
| instance_id required | string <uuid> Defines which instance to attach block storage |
Responses
Response samples
- 200
{- "type": "INVALID_OPERATION",
- "message": "Block storage already attached to an instance"
}Resize block storage
This endpoint resize block storage.
Authorizations:
path Parameters
| block_storage_id required | integer Id of block storage |
Request Body schema: application/x-www-form-urlencodedrequired
| size required | integer Size of storage |
Responses
Response samples
- 200
{- "message": "Block storage successfully resized",
- "data": {
- "storage_id": "41f26dc9-1d11-4ad7-b195-796bcf6ba52d",
- "new_size": "60GB"
}
}Delete block storage
This endpoint delete block storage.
Authorizations:
path Parameters
| block_storage_id required | integer Id of block storage |
Responses
Response samples
- 200
{- "message": "Block storage successfully removed",
- "data": {
- "storage_id": "41f26dc9-1d11-4ad7-b195-796bcf6ba52d"
}
}Get available blocks
This endpoint Get available non attached block storages.
Authorizations:
query Parameters
| location_id required | integer Id of location. |
Responses
Response samples
- 200
{- "message": "Available non-attached block storage",
- "data": [
- {
- "id": "41f26dc9-1d11-4ad7-b195-796bcf6ba52d",
- "name": "test-storage-aja",
- "size": "50GB"
}
]
}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.
Response samples
- 200
{- "message": "My SSH Key",
- "data": [
- {
- "id": 1,
- "title": "Macbook Mamah",
- "number_of_instance": 0,
- "created_at": "28 June 2023 14:46",
- "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDZ36wRF0fUvwM1KNUi+92Lvnrrk..."
}
]
}Create SSH
Create SSH
Authorizations:
Request Body schema: application/x-www-form-urlencodedrequired
| title required | string Title of ssh |
| key required | string Public key of ssh |
Responses
Response samples
- 200
{- "message": "SSH Key successfully created",
- "data": {
- "credential_id": 1
}
}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:
query Parameters
| location | integer <int64> Id of location |
Responses
Response samples
- 200
{- "message": "Available Systems",
- "data": [
- {
- "id": 6,
- "os_name": "Ubuntu",
- "os_version": [
- {
- "id": 22,
- "version": 18.04,
- "description": "Ubuntu version 18.04",
- "min_cpu": 1,
- "min_memory": 1,
- "min_storage": 20
}
]
}
]
}Get tier pricing
Get tier pricing
Authorizations:
path Parameters
| tier_id required | integer <int64> Id of tier |
Responses
Response samples
- 200
{- "message": "Pricing list",
- "data": [
- {
- "id": 1,
- "name": "CPU",
- "price_per_hour": 77.77778,
- "price_per_day": 1866.66662,
- "price_per_month": 56000
}
]
}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.
Response samples
- 200
{- "message": "This month summary",
- "data": {
- "current_balance": 37295.71126,
- "last_invoices": [
- {
- "amount": 25000,
- "date": "2024-03-15"
}
], - "current_costs": {
- "estimated_balance": 37295.71126,
- "estimated_partial_month_total": 7500
}
}
}Get Deposit History
Retrieves the history of deposits.
Authorizations:
query Parameters
| limit | integer Limit response data deposit history. |
| page | integer Number of page. |
Responses
Response samples
- 200
{- "message": "Deposit Histories",
- "data": [
- {
- "id": "d1defd97-3519-41a5-ac9e-25646436fae1",
- "invoice_number": "INV202404220001",
- "description": "Top-up Rp100.000,00",
- "detail": {
- "amount": 100000,
- "fee": 0,
- "payment_fee": 1000
}, - "method": "BCA VA",
- "status": "SUCCESS",
- "created_at": "2024-04-22 14:00:00",
- "expired_at": null
}
], - "pagination": {
- "total": 2,
- "limit": 10,
- "page": 1,
- "per_page": 10,
- "current_page": 1,
- "total_page": 1
}
}Initiate the export of deposit history.
Triggers the process to export the deposit history based on specified criteria.
Authorizations:
query Parameters
| start | string <date> Start of data. |
| end | string <date> End of date. |
Responses
Response samples
- 200
{- "message": "Exporting deposit history",
- "data": {
- "export_id": "export-uuid-example",
- "status": "pending"
}
}Retrieve detailed information for a specific deposit.
Fetches the detailed information of a deposit based on the provided invoice ID.
Authorizations:
path Parameters
| invoice_id required | string Defines which invoice to retrieve. |
Responses
Response samples
- 200
{- "message": "Invoice detail",
- "data": {
- "id": "78c5",
- "method": "BCA VA",
- "detail": {
- "amount": 100000,
- "fee": 0,
- "payment_fee": 1000
}, - "qr_string": null,
- "status": "SUCCESS",
- "created_at": "26 August 2024 14:36:00",
- "expired_at": null
}
}Retrieve the history of credit transactions.
Fetches a list of all credit transactions made.
Authorizations:
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
- 200
{- "message": "credit history",
- "data": [
- {
- "id": 4,
- "transaction_id": "null",
- "description": "Reward First Topup reward of Rp10.000,00 for yourusername@local.coff",
- "amount": 10000,
- "balance_after": 1000000,
- "transaction_at": "2023-07-20 13:05:18"
}, - {
- "id": 3,
- "transaction_id": "null",
- "description": "Top up : Rp100.000,00",
- "amount": 100000,
- "balance_after": 1000000,
- "transaction_at": "2023-07-20 13:05:18"
}
], - "pagination": {
- "total": 2,
- "limit": 10,
- "page": 1,
- "per_page": 10,
- "current_page": 1,
- "total_page": 1
}
}Retrieve the monthly summary for postpaid billing.
Fetches a summary of the postpaid billing information for the current month.
Authorizations:
Responses
Response samples
- 200
{- "message": "Postpaid customer billing summary",
- "data": {
- "total_paid": 0,
- "total_paid_amount": 0,
- "total_unpaid": 1,
- "total_unpaid_amount": 547268.75536,
- "est_month_cost": 392357.16668
}
}Retrieve monthly postpaid invoices.
Fetches a list of postpaid invoices for the current month.
Authorizations:
Responses
Response samples
- 200
{- "message": "Your invoices",
- "data": {
- "page": {
- "total": 1,
- "count": 1,
- "per_page": 10,
- "current_page": 1,
- "total_pages": 1
}, - "data": [
- {
- "invoice_number": "MXIPOST02202400001",
- "description": "Resource usage PT. Mencari Cinta Sejati on January 2024",
- "detail": {
- "amount": 492974.55186,
- "vat": 54227.2007,
- "total": 547201.75256
}, - "status": "Not Paid",
- "method": null,
- "created_at": "26 February 2024 10:07:08"
}
]
}
}Get available payment methods.
Retrieves a list of available payment methods.
Authorizations:
query Parameters
| amount | integer Amount of payment methods. |
Responses
Response samples
- 200
{- "message": "Available payment methods",
- "data": {
- "bank": [
- {
- "name": "PERMATA VA",
- "code": "BT",
- "fee": 0,
- "vat": 1100
}, - {
- "name": "CIMB NIAGA VA",
- "code": "B1",
- "fee": 3000,
- "vat": 1100
}, - {
- "name": "ATM BERSAMA VA",
- "code": "A1",
- "fee": 0,
- "vat": 1100
}, - {
- "name": "BNI VA",
- "code": "I1",
- "fee": 3000,
- "vat": 1100
}, - {
- "name": "MANDIRI VA H2H",
- "code": "M2",
- "fee": 3000,
- "vat": 1100
}, - {
- "name": "BCA VA",
- "code": "BC",
- "fee": 5000,
- "vat": 1100
}, - {
- "name": "BRI VA",
- "code": "BR",
- "fee": 4000,
- "vat": 1100
}, - {
- "name": "BNC VA",
- "code": "NC",
- "fee": 4000,
- "vat": 1100
}
], - "card": [
- {
- "name": "CREDIT CARD",
- "code": "VC",
- "fee": 2822,
- "vat": 1100
}
], - "ritel": [
- {
- "name": "RETAIL",
- "code": "FT",
- "fee": 7500,
- "vat": 1100
}, - {
- "name": "INDOMARET",
- "code": "IR",
- "fee": 7500,
- "vat": 1100
}
], - "ewallet": [
- {
- "name": "OVO",
- "code": "OV",
- "fee": 166,
- "vat": 1100
}, - {
- "name": "SHOPEEPAY APP",
- "code": "SA",
- "fee": 0,
- "vat": 1100
}, - {
- "name": "DANA",
- "code": "DA",
- "fee": 0,
- "vat": 1100
}
], - "qris": [
- {
- "name": "SHOPEEPAY QRIS",
- "code": "SP",
- "fee": 0,
- "vat": 1100
}, - {
- "name": "LINKAJA QRIS",
- "code": "LQ",
- "fee": 0,
- "vat": 1100
}, - {
- "name": "NOBU QRIS",
- "code": "NQ",
- "fee": 0,
- "vat": 1100
}
]
}
}Create invoice payment.
Creates an invoice payment.
Authorizations:
Request Body schema: application/x-www-form-urlencodedrequired
| amount required | integer Amount of payment. |
| payment_method required | string Payment method of payment. |
Responses
Response samples
- 200
{- "message": "Invoice created",
- "data": {
- "merchant_code": "DS13539",
- "reference_number": "DS1353924PO24JJJNT45SC25",
- "amount": 116000,
- "details": {
- "amount": 100000,
- "payment_fee": 5000,
- "vat": 11000
}, - "va_number": "7007014007544410",
- "qr_string": null,
- "invoice_id": "a5defc97-1918-4101-ac9e-2594943bfa0c"
}
}Get report summary.
Retrieves a summary of the billing report.
Authorizations:
query Parameters
| limit | integer Limit response data deposit history. |
| page | integer Number of page. |
Responses
Response samples
- 200
{- "message": "Summary billing report",
- "data": {
- "data": [
- {
- "id": null,
- "billing periode": "March 2024",
- "billing_date": "2024-03-30T17:00:00.000000Z",
- "status": "Not Settled",
- "fully_settle": false,
- "total": 13195.00188,
- "can_download": false
}, - {
- "id": null,
- "billing periode": "February 2024",
- "billing_date": "2024-02-28T17:00:00.000000Z",
- "status": "Settled",
- "fully_settle": true,
- "total": 728280.1034,
- "can_download": true
}
], - "page": {
- "total": 2,
- "count": 2,
- "per_page": 10,
- "current_page": 1,
- "total_pages": 1
}
}
}Get summary detail.
Defines which invoice to retrieve.
Authorizations:
path Parameters
| summary_date required | string <date> Defines which invoice to retrieve |
Responses
Response samples
- 200
{- "message": "Billing report for 337fc06d-d85f-4cd0-acc8-4b497831e1dd",
- "data": {
- "id": "337fc06d-d85f-4cd0-acc8-4b497831e1dd",
- "billing periode": "January 2024",
- "billing_date": "2024-01-31",
- "status": "Settled",
- "fully_settle": true,
- "total": 492974.55186,
- "can_download": true,
- "services": [
- {
- "service": "Instance",
- "total": 349119.87828,
- "reports": [
- {
- "id": 85,
- "service_name": "vm hostname",
- "service_type": "Instance",
- "tier_name": "AMD Epyc",
- "tier_icon": null,
- "total_cost": 18597.68693,
- "details": [
- {
- "name": "SSD: 30 GB",
- "base_price": 83.33334,
- "total_uptime_hour": 58.37,
- "total_cost": 4863.89278
}, - {
- "name": "CPU: 1 core",
- "base_price": 118.05555,
- "total_uptime_hour": 58.28,
- "total_cost": 6880.67135
}, - {
- "name": "RAM: 2 GB",
- "base_price": 83.33334,
- "total_uptime_hour": 58.28,
- "total_cost": 4856.94539
}, - {
- "name": "SNAPSHOT: snp-2 - 50 GB",
- "base_price": 104.1665,
- "total_uptime_hour": 18.87,
- "total_cost": 1965.27463
}, - {
- "name": "BACKUP: 30 GB",
- "base_price": 41.6667,
- "total_uptime_hour": 0.53,
- "total_cost": 22.22224
}, - {
- "name": "SNAPSHOT: snp-1 - 50 GB",
- "base_price": 104.1665,
- "total_uptime_hour": 0.08,
- "total_cost": 8.68054
}
]
}, - {
- "id": 87,
- "service_name": "vm hostname",
- "service_type": "Instance",
- "tier_name": "AMD Epyc",
- "tier_icon": null,
- "total_cost": 38923.74424,
- "details": [
- {
- "name": "CPU: 1 core",
- "base_price": 118.05555,
- "total_uptime_hour": 124.63,
- "total_cost": 14713.65796
}, - {
- "name": "RAM: 1 GB",
- "base_price": 41.66667,
- "total_uptime_hour": 124.63,
- "total_cost": 5193.05721
}, - {
- "name": "SSD: 30 GB",
- "base_price": 83.3334,
- "total_uptime_hour": 124.63,
- "total_cost": 10386.11942
}, - {
- "name": "BACKUP: 50 GB",
- "base_price": 69.4445,
- "total_uptime_hour": 123,
- "total_cost": 8541.6735
}, - {
- "name": "BACKUP: 30 GB",
- "base_price": 41.6667,
- "total_uptime_hour": 1.52,
- "total_cost": 63.19452
}, - {
- "name": "SNAPSHOT: snp-1 - 50 GB",
- "base_price": 104.1665,
- "total_uptime_hour": 0.25,
- "total_cost": 26.04163
}
]
}
]
}, - {
- "service": "Public Network",
- "total": 97027.78427,
- "reports": [
- {
- "id": 56,
- "service_name": "192.168.1.183",
- "service_type": "Public Network",
- "total_cost": 24999.9984,
- "details": [
- {
- "name": "IP: 1 IP address",
- "base_price": 34.72222,
- "total_uptime_hour": 720,
- "total_cost": 24999.9984
}
]
}, - {
- "id": 82,
- "service_name": "100.100.100.100",
- "service_type": "Public Network",
- "total_cost": 24999.9984,
- "details": [
- {
- "name": "IP: 1 IP address",
- "base_price": 34.72222,
- "total_uptime_hour": 720,
- "total_cost": 24999.9984
}
]
}
]
}, - {
- "service": "Block Storage",
- "total": 46826.88931,
- "reports": [
- {
- "id": 84,
- "service_name": "block storage",
- "service_type": "Block Storage",
- "total_cost": 40000.032,
- "details": [
- {
- "name": "BLOCK STORAGE HDD: 20 GB",
- "base_price": 55.5556,
- "total_uptime_hour": 720,
- "total_cost": 40000.032
}
]
}, - {
- "id": 89,
- "service_name": "block storage",
- "service_type": "Block Storage",
- "total_cost": 6826.85731,
- "details": [
- {
- "name": "BLOCK STORAGE HDD: 20 GB",
- "base_price": 55.5556,
- "total_uptime_hour": 122.88,
- "total_cost": 6826.85731
}
]
}
]
}
]
}
}Export service usage.
Defines which summary to export.
Authorizations:
path Parameters
| summary_id required | string Defines which summary to export |
Responses
Response samples
- 200
{- "message": "Exporting summary data",
- "data": {
- "export_id": "export-uuid-example",
- "status": "pending"
}
}