Schedule A Demo|Contact Sales: +254 700 000 000
DocsAPI ReferenceInstances API
API Reference

Instances API

REST API reference for VPS instance management.

Endpoints

MethodPathDescription
GET/api/instancesList all instances
POST/api/instancesCreate a new instance
GET/api/instances/:idGet instance details
PATCH/api/instances/:idUpdate instance name
DELETE/api/instances/:idDelete instance
POST/api/instances/:id/startStart instance
POST/api/instances/:id/stopStop instance
POST/api/instances/:id/restartRestart instance
GET/api/instances/:id/metricsGet instance metrics

List instances

bash
GET /api/instances?page=1&limit=20&status=running&region=af-ke-1

Create instance request body

json
{
  "name": "web-prod-01",
  "type": "vps.medium",
  "os": "ubuntu-22.04",
  "region": "af-ke-1"
}
← Previous
API Authentication
Next →
Storage API

Was this article helpful?

Need more help? Open a support ticket

On this page

Endpoints
List instances
Create instance request body
Get support