CloudNexus Infrastructure API
Deploy, scale, and manage cloud resources programmatically. The CloudNexus API provides unified access to compute, storage, networking, and orchestration services.
Prerequisites
Before making API requests, ensure you have the following:
- A valid CloudNexus account with billing enabled
- API credentials (Key/Secret pair or JWT token)
- Region scope configured in your dashboard
- Rate limit awareness:
100 req/minfor standard,1000 req/minfor enterprise
API Key Security
Never expose your secret key in client-side code or public repositories. Use environment variables or secret managers.
Authentication
All requests must include your API key in the Authorization header. CloudNexus supports both static keys and time-limited OAuth2 tokens.
HTTP
# Standard API Key Authentication curl -X GET https://api.cloudnexus.io/v2/instances \ -H "Authorization: Bearer cn_live_sk_8f3a2b..." \ -H "Content-Type: application/json"
JavaScript (SDK)
import { CloudNexus } from '@cloudnexus/sdk'; const cn = new CloudNexus({ apiKey: process.env.CN_API_KEY, region: 'us-east-1', retries: 3 }); const instances = await cn.instances.list();
Core Configuration
CloudNexus uses a declarative configuration model. Resources are defined using JSON or YAML manifests and applied via the API or CLI.
| Parameter | Type | Required | Description |
|---|---|---|---|
region |
string | Yes | Deployment region (e.g., eu-west-2) |
tier |
string | Yes | Compute tier: shared, dedicated, gpu |
autoscale |
object | No | Min/max instances and trigger metrics |
vpc_id |
string | No | Existing VPC for isolated networking |
tags |
object | No | Key-value labels for resource grouping |
Pro Tip
Use the
cn apply CLI command to validate manifests locally before pushing to production. It catches 94% of configuration errors.
Quick Start: Deploy a Compute Instance
- Initialize the SDK or configure your CLI
- Define your resource spec (JSON/YAML)
- Submit to the provisioning endpoint
- Monitor deployment status via WebSocket or polling
YAML Manifest
apiVersion: cloudnexus.io/v2 kind: ComputeInstance metadata: name: app-server-prod region: us-east-1 spec: tier: dedicated-8x16 image: ubuntu-22.04-lts network: cidr: 10.0.0.0/24 publicIP: true storage: - type: nvme size: 200 # GB autoscale: min: 2 max: 10 metric: cpu_utilization threshold: 75
Terminal
# Deploy the manifest cn apply -f instance-prod.yaml # Wait for provisioning & get connection details cn wait instance/app-server-prod --status running cn ssh app-server-prod
Next Steps
Now that you understand the core API structure, explore these advanced topics:
- Multi-Region Load Balancing - Configure global traffic routing
- Secrets & Config Management - Securely inject environment variables
- Observability Stack - Metrics, logs, and tracing integration
- Terraform Provider - Infrastructure as Code support