Onidel Cloud
  • Onidel Home Page
  • Onidel Cloud Panel
  • Cloud Status
  • Introduction
  • Information
    • Networking
    • Hardware Specifications
    • Datacenters
  • API Reference
    • Changelog
    • Authentication
    • OS Template
    • Instance Type
    • Instance Price
    • Team
      • Get Teams
    • Virtual Machine
      • List Instances
      • Get Instance Backups
      • Create Instance
      • Get Instance
      • Update Instance
      • Stop Instance
      • Reboot Instance
      • Snapshot Instance
      • Delete Instance
    • Backups
      • List Backups
      • Generate Download URL
    • Snapshots
      • List Snapshots
      • Delete Snapshot
      • Generate Download URL
  • Features
    • Data Transfer (Bandwidth) Pooling
    • Hourly Billing
    • VM Scaling
    • BYOIP & BGP
    • Attach a Snapshot/Backup to your Server
    • Peer Server
  • Automatic Backup
  • Cloud Server
    • IPv4 Configuration
    • IPv6 Configuration
    • Using Custom ISO
    • Reverse DNS
    • Disable Secure Boot
    • Backup and Snapshot Download
  • ACCOUNT
    • Supported Currencies
    • Chargebacks & Disputes
    • Enable 2-FA
    • Affiliate Program
  • Policies
    • Service Level Agreement
    • Terms of Service
    • Acceptable Usage Policy
    • Privacy Policy
Powered by GitBook
On this page
  1. API Reference
  2. Virtual Machine

Get Instance

API Version: 1.1.0 (06-Jan-2025)

PreviousCreate InstanceNextUpdate Instance

Last updated 2 months ago

Get VPS instance details

Get VPS instance details

get

/vm/{vm_id}

Authorizations
Path parameters
vm_idstring · uuidrequired

VPS UUID that need to be considered for filter

Query parameters
team_idstring

Team ID that need to be considered for filter. Default team will be used if not provided.

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.cloud.onidel.com/vm/{vm_id}' \
  --header 'Authorization: YOUR_API_KEY'
200
400
401
{
  "id": "c1d45377-b2a9-4407-ab8d-6909c34dfaac",
  "name": "ubuntu-vm-4vcpu-8gb",
  "vcpu": 2,
  "ram": 4096,
  "disk": 40,
  "bw_used": 12.5,
  "main_ipv4": "160.22.79.122",
  "main_ipv6": "2401:a4a0:1:90::1",
  "username": "root",
  "password": "aHbf6!&8sH",
  "template": "Ubuntu 24.04 x64 LTS",
  "created_at": "2024-10-04T10:20:22.922772Z",
  "renewed_at": "2024-10-04T10:20:22.922772Z",
  "due_date": "2024-10-04T10:20:22.922772Z",
  "recurring_amount": 5.5,
  "payment_currency": "AUD",
  "billing_cycle": 1,
  "status": 1
}

Successful operation