Virtual Machine
List VMs in a specific location of a project
API Documentation
Project
Firewall
- GETReturn the list of firewalls in the project
- POSTCreate a new firewall
- GETGet details of a specific firewall
- DELDelete a specific firewall
- GETReturn the list of firewalls in the project and location
- POSTAttach a subnet to firewall
- POSTDetach a subnet from firewall
- GETGet details of a specific firewall
- DELDelete a specific firewall
- GETGet details of a specific firewall
- POSTCreate a new firewall
- DELDelete a specific firewall
Firewall Rule
- POSTCreate a new firewall rule
- GETGet details of a firewall rule
- DELDelete a specific firewall rule
- POSTCreate a new firewall rule
- GETGet details of a firewall rule
- POSTCreate a new firewall rule
- DELDelete a specific firewall rule
- POSTCreate a new firewall rule
- GETGet details of a firewall rule
- POSTCreate a new firewall rule
- DELDelete a specific firewall rule
- DELDelete a specific firewall rule
Load Balancer
- GETList Load Balancers in a specific project
- GETGet details of a specific Load Balancer
- POSTCreate a new Load Balancer in a project
- GETList Load Balancers in a specific location of a project
- GETGet details of a specific Load Balancer in a location with ID
- DELDelete a specific Load Balancer with ID
- GETGet details of a specific Load Balancer in a location
- POSTCreate a new Load Balancer in a specific location of a project
- DELDelete a specific Load Balancer
- PATCHUpdate a Load Balancer in a specific location of a project
- POSTAttach a VM to a Load Balancer in a specific location of a project
- POSTDetach a VM from a Load Balancer in a specific location of a project
Postgres Database
- GETList Postgres Databases in a specific location of a project
- POSTFailover a specific Postgres Database with ID
- GETGet details of a specific Postgres Database in a location with ID
- DELDelete a specific Postgres Database with ID
- GETDownload CA certificates for a specific Postgres Database in a location with ID
- POSTReset super-user password of the Postgres Database
- POSTRestore a new Postgres Database in a specific location of a project with ID
- GETGet details of a specific Postgres database in a location
- POSTCreate a new Postgres Database in a specific location of a project
- DELDelete a specific Postgres Database
- GETDownload CA certificates for a specific Postgres Database in a location with name
- POSTReset superuser password of the Postgres database
- POSTRestore a new Postgres database in a specific location of a project
- GETList visible Postgres Databases
Postgres Firewall Rule
Postgres Metric Destination
Private Subnet
- GETList Private Subnets in a specific location of a project
- GETGet details of a specific Private Subnet in a location with ID
- DELDelete a specific Private Subnet with ID
- GETGet details of a specific Private Subnet in a location
- POSTCreate a new Private Subnet in a specific location of a project
- DELDelete a specific Private Subnet
- GETList visible Private Subnets
Virtual Machine
- GETList VMs in a specific location of a project
- GETGet details of a specific VM in a location with ID
- DELDelete a specific VM with ID
- GETGet details of a specific VM in a location
- POSTCreate a new VM in a specific location of a project
- DELDelete a specific VM
- GETList all VMs created under the given project ID and visible to logged in user
Virtual Machine
List VMs in a specific location of a project
GET
/
project
/
{project_id}
/
location
/
{location}
/
vm
curl --request GET \
--url https://api.ubicloud.com/project/{project_id}/location/{location}/vm \
--header 'Authorization: Bearer <token>'
{
"count": 123,
"items": [
{
"id": "vmhfy8gff8c67hasb0eez2k1pd",
"ip4": "127.0.0.1",
"ip4_enabled": true,
"ip6": "2606:4700:3108::ac42:2835",
"location": "eu-central-h1",
"name": "my-vm-name",
"size": "<string>",
"state": "<string>",
"storage_size_gib": 123,
"unix_user": "<string>"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The Ubicloud location/region
Example:
"eu-central-h1"
ID of the project
Example:
"pjkkmx0f2vke4h36nk9cm8v8q0"
Query Parameters
Pagination - Start after
Pagination - Page size
Pagination - Order column
Response
200
application/json
A list of VMs
ID of the VM
Example:
"vmhfy8gff8c67hasb0eez2k1pd"
IPv4 address
Whether IPv4 is enabled
IPv6 address
Location of the VM
Example:
"eu-central-h1"
Name of the VM
Example:
"my-vm-name"
Size of the underlying VM
State of the VM
Storage size in GiB
Unix user of the VM
curl --request GET \
--url https://api.ubicloud.com/project/{project_id}/location/{location}/vm \
--header 'Authorization: Bearer <token>'
{
"count": 123,
"items": [
{
"id": "vmhfy8gff8c67hasb0eez2k1pd",
"ip4": "127.0.0.1",
"ip4_enabled": true,
"ip6": "2606:4700:3108::ac42:2835",
"location": "eu-central-h1",
"name": "my-vm-name",
"size": "<string>",
"state": "<string>",
"storage_size_gib": 123,
"unix_user": "<string>"
}
]
}