API Endpoints

Complete reference for all available API endpoints and their usage.

VPS Management

List Instances

GET /v1/instances

# Query Parameters
page: integer (optional)
limit: integer (optional)
status: string (optional)

# Response
{
  "instances": [
    {
      "id": "inst_123",
      "name": "web-server-1",
      "status": "running",
      "ip": "10.0.0.1",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 10
  }
}

Create Instance

POST /v1/instances

# Request Body
{
  "name": "web-server-1",
  "plan": "standard-2x",
  "region": "us-east",
  "image": "ubuntu-22.04",
  "ssh_keys": ["key_123"]
}

# Response
{
  "instance": {
    "id": "inst_123",
    "name": "web-server-1",
    "status": "provisioning",
    "ip": null,
    "created_at": "2024-01-01T00:00:00Z"
  }
}

Instance Operations

Instance Actions

Start Instance

POST /v1/instances/{id}/start

# Response
{
  "action": {
    "id": "act_123",
    "type": "start",
    "status": "in-progress"
  }
}

Stop Instance

POST /v1/instances/{id}/stop

# Response
{
  "action": {
    "id": "act_124",
    "type": "stop",
    "status": "in-progress"
  }
}

Resource Management

Resize Instance

POST /v1/instances/{id}/resize

# Request Body
{
  "plan": "standard-4x"
}

# Response
{
  "action": {
    "id": "act_125",
    "type": "resize",
    "status": "in-progress"
  }
}

Networking

IP Management

Assign IP

POST /v1/instances/{id}/ips

# Request Body
{
  "type": "ipv4"
}

# Response
{
  "ip": {
    "address": "10.0.0.2",
    "type": "ipv4",
    "reverse_dns": null
  }
}

Need Help?

Check out our code examples or contact support for assistance with API integration.

View Code ExamplesContact Support