CloudNexus REST API Reference

🔐 Authentication

All API requests require an API key passed via the Authorization header. Keys can be generated in your CloudNexus dashboard.

Header Format

Authorization: Bearer <YOUR_API_KEY>
Content-Type: application/json

📋 Instances

GET /v2/instances

Retrieve a paginated list of all virtual instances associated with your account.

# Filter by region and status
curl -X GET "https://api.cloudnexus.dev/v2/instances?region=us-east-1&status=running&page=1&limit=20" \\
  -H "Authorization: Bearer $CN_API_KEY" \\
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": "inst_9f8a7b6c",
      "name": "prod-api-01",
      "status": "running",
      "region": "us-east-1",
      "cpu_cores": 4,
      "memory_gb": 16,
      "created_at": "2024-11-15T08:30:00Z"
    }
  ],
  "pagination": {
    "total": 42,
    "page": 1,
    "per_page": 20
  }
}

POST /v2/instances

Provision a new high-performance virtual instance with NVMe storage and auto-scaling enabled.

{
  "name": "staging-worker-02",
  "plan": "cn-pro-8",
  "region": "eu-west-2",
  "image": "ubuntu-22.04-lts",
  "auto_scale": true,
  "tags": ["staging", "backend"]
}

{
  "id": "inst_a1b2c3d4",
  "status": "provisioning",
  "ip_address": "10.0.42.18",
  "message": "Instance is being deployed. ETA: 45s"
}

🗄️ Managed Databases

GET /v2/databases

List all managed database clusters. Supports MySQL, PostgreSQL, and Redis.

curl -X GET "https://api.cloudnexus.dev/v2/databases" \\
  -H "Authorization: Bearer $CN_API_KEY"

{
  "data": [
    {
      "id": "db_postgres_7x",
      "engine": "postgresql",
      "version": "15.4",
      "status": "active",
      "connection_string": "postgresql://user:***@db-7x.cn.cloudnexus.dev:5432/app"
    }
  ]
}

🛠️ SDKs & Tools

🐍

Python

pip install cloudnexus-sdk

🟨

Node.js

npm install @cloudnexus/sdk

🐹

Go

go get github.com/cloudnexus/go-sdk

📮

Postman

Import our official collection

⚡ Rate Limits & Pagination

API requests are limited to 1,000 requests per minute per API key. Pagination uses cursor-based navigation for large datasets.

Response Headers

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1715660000
Link: <https://api.cloudnexus.dev/v2/instances?cursor=eyJpZCI6NDJ9>; rel="next"