Compute Instances API

Manage virtual machines, deployments, and scaling policies. Create, configure, and monitor compute resources with our RESTful API.

Authentication

All requests to the Compute Instances API require authentication via API Key. Include your key in the Authorization header:

curl -X GET https://api.cloudnexus.io/v2/instances \
  -H "Authorization: Bearer cn_live_sk_9f8e7d6c5b4a3210" \
  -H "Content-Type: application/json"

const axios = require('axios');

const response = await axios.get('https://api.cloudnexus.io/v2/instances', {
  headers: {
    'Authorization': 'Bearer cn_live_sk_9f8e7d6c5b4a3210'
  }
});

import requests

headers = {
    'Authorization': 'Bearer cn_live_sk_9f8e7d6c5b4a3210'
}

response = requests.get('https://api.cloudnexus.io/v2/instances', headers=headers)

Endpoints

The following endpoints are available for managing compute instances:

Create an Instance

Launch a new compute instance by sending a POST request to the instances endpoint. Specify region, plan, and networking configuration.

Request Body

{
  "region": "us-east-1",
  "plan": "standard-4x",
  "image": "ubuntu-22.04-lts",
  "network": {
    "subnet_id": "sub_8f7e6d5c4b",
    "assign_public_ip": true
  },
  "tags": {"env": "production", "app": "api-server"}
}

Response

{
  "id": "inst_3x9y2z1a0b",
  "status": "provisioning",
  "region": "us-east-1",
  "plan": "standard-4x",
  "public_ip": "104.26.18.42",
  "created_at": "2025-01-15T08:32:14Z",
  "links": {
    "self": "https://api.cloudnexus.io/v2/instances/inst_3x9y2z1a0b",
    "console": "https://console.cloudnexus.io/instances/inst_3x9y2z1a0b"
  }
}

Rate Limits & Best Practices

The Compute API enforces rate limits to ensure platform stability:

• Global Limit: 100 requests per second per API key
• Instance Creation: Max 10 instances per second
• Pagination: Use ?page=2&limit=50 for large datasets

Instance Webhooks

Subscribe to instance lifecycle events (provisioned, stopped, terminated, scaled) via webhooks. Configure your endpoint in the console or via the /v2/webhooks endpoint.

Supported events: instance.created, instance.ready, instance.stopped, instance.terminated, instance.scaled.