Deepstone API
  • Introduction
  • API Keys
  • Rate Limits
  • Endpoint List
    • Resource Pool
Powered by GitBook
On this page
  • List all available Resource Pool
  • Get single resource pool data with VM list
  • Return list of available ISO and Guest OS
  • Create New VM
  • Get single VM data and status
  • Get single VM status
  • Edit VM
  • Turn On specific VM
  • Turn Off specific VM
  • Resetting power to specific VM
  • Return all rules for specific VM
  • Add a rule to Firewall table
  • Delete single firewall rule
  • Delete single vm
  1. Endpoint List

Resource Pool

The Resource Pool is the logical container of all the Virtual Machines owned by the Customer.

Each Resource Pool has a set of resources reserved for it within which the user, via API or portal, can create all the desired workloads.

Below is the documentation to support the management of Resource Pools and the related Virtual Machines.

Beta Status of Endpoint APIs

Please note that the group of endpoint APIs discussed in this document are currently in beta. This means that they are in a trial phase and are not yet finalized. While in beta, these APIs may be subject to change and could have limited support. We encourage users to test these beta APIs and provide feedback to help us improve their functionality before a full release. Keep in mind that during the beta period, the performance and reliability standards may not reflect those of the final version.


List all available Resource Pool

GET https://api.deepstone.cloud/v1/resource-pool/

Get single resource pool data with VM list

GET https://api.deepstone.cloud/v1/resource-pool/[resource-pool-id]

Return list of available ISO and Guest OS

GET https://api.deepstone.cloud/v1/resource-pool/iso-inventory

Create New VM

POST https://api.deepstone.cloud/v1/resource-pool/[resource-pool-id]

The process is not immediate and may continue after the endpoint responds

Request Body

Name
Type
Description

name*

String

Name of Virtual Machine

iso_id*

Int

ID of selected ISO

cpu*

int

Numbers of CPU

ram*

int

Size of memory, in MiB

datacenter*

String

Datacenter for VM. "Deca1", "Deca2"

storage*

int

Size of storage, in GiB

String

Get single VM data and status

GET https://api.deepstone.cloud/v1/vm/[vm-code]

Get single VM status

GET https://api.deepstone.cloud/v1/vm/[vm-code]/status

Edit VM

POST https://api.deepstone.cloud/v1/vm/[vm-code]

This method work only if VM is "POWER-OFF"

Request Body

Name
Type
Description

cpu*

int

Numbers of CPU

ram*

int

Size of memory, in MiB

storage*

int

Size of storage, in GiB

String

Turn On specific VM

POST https://api.deepstone.cloud/v1/vm/[vm-code]/power-on

The process is not immediate and may continue after the endpoint responds

Turn Off specific VM

POST https://api.deepstone.cloud/v1/vm/[vm-code]/power-off

The process is not immediate and may continue after the endpoint responds

Resetting power to specific VM

POST https://api.deepstone.cloud/v1/vm/[vm-code]/power-reset

The process is not immediate and may continue after the endpoint responds

Return all rules for specific VM

GET https://api.deepstone.cloud/v1/vm/[vm-code]/firewall-rule

The process is not immediate and may continue after the endpoint responds

Add a rule to Firewall table

POST https://api.deepstone.cloud/v1/vm/[vm-code]/firewall-rule

Request Body

Name
Type
Description

port*

Int

TCP/UDP Port Number

type*

String

"TCP" / "UDP"

cidr

String

JSON Array of Subnets. 0.0.0.0/0 for all

Delete single firewall rule

DELETE https://api.deepstone.cloud/v1/vm/[vm-code]/firewall-rule/[rule-id]

Delete single vm

DELETE https://api.deepstone.cloud/v1/vm/[vm-code]

Operation permitted with machine off only

PreviousEndpoint List

Last updated 1 year ago