Saltar al contenido
NimbusNexus

Docs · API v1

The NimbusNexus API. One REST surface for every resource.

Provision VMs, run databases, attach block storage, push objects — same authentication, same JSON shapes, same idempotency semantics across every resource. Stable since v1; breaking changes ship behind a new version, never on top of an existing one.

Quickstart →Browse API reference

Base URL https://api.nimbusnexus.net

Start here

Inicio rápido

Generate an API key, pick a region, and create your first VM in three requests.

Open the quickstart →

Conceptos

Autenticación
API keys, scopes, project boundaries, and how to rotate credentials safely.
Convenciones
Patterns the API follows everywhere — resource ids, pagination, errors, idempotency, long-running operations.
Platform webhooks
Subscribe to your infrastructure's lifecycle events. HMAC-signed POSTs to a URL you control.
Rate limiting
Per-key request budgets, the headers we return, and the right backoff strategy.
Pagination
Cursor pagination on every list endpoint. Stable across inserts, no offset drift.
Idempotency
Safe-to-retry mutating requests using the Idempotency-Key header.
Errors
The error shape, the error codes that matter, and how to handle each.
Security model
How keys, scopes, projects, and audit logs combine to bound blast radius.
Versioning policy
How we evolve the API without breaking your code.

Guías

Run a production Postgres in 10 minutes
Provision a managed Postgres with HA, backups, and zero-downtime upgrades — three API calls.
Deploy a static site
Object storage as a hosting target — bucket, public read, custom domain, ~5 minutes.
Migrate from AWS RDS
Live-migrate Postgres or MySQL from RDS with zero data loss and ~30s downtime.
Blue/green deploys with floating IPs
Zero-downtime deploys by swinging a floating IP between two warm VMs.
Multi-region failover
DNS-level failover across two regions with health-checked routing.
Monitor a VM fleet
Prometheus scrapes, NimbusNexus-emitted metrics, and the alerts that matter.
Container deployment patterns
Single VM, systemd-managed Docker, behind a floating IP.
Project networking setup
Networks, subnets, routers, and security groups — canonical wiring for a multi-tier app.
Optimizing your monthly bill
The five highest-leverage things to do if your invoice is bigger than you expected.

SDK y CLI

TypeScript SDK
Typed client for the NimbusNexus REST API. ESM + CJS, Node 20+, browser-friendly.
Python SDK
Typed Python client. Sync + async, Pydantic models, Python 3.11+.
Go SDK
Idiomatic Go client. Context-aware, no dependencies, Go 1.22+.
CLI
nimbus — the command-line interface for the REST API.

Webhooks (product)

Overview
The managed webhook platform — publish once, and we sign, retry, and replay every delivery to your subscribers.
Quickstart
Register an endpoint, publish an event, and verify the signed delivery.
Signature verification
The signing contract for delivered webhooks — headers, the HMAC construction, and the three rules for checking it.
SDKs
Typed clients for Python, TypeScript, and Go — verify, publish, buffer, and manage from code.
CLI
nn-webhooks — a single static binary for publishing events and draining the dead-letter queue.

Inboxes (product)

Overview
Disposable email addresses for testing — allocate an address, receive real mail at it, and read it back over an API.
Quickstart
Allocate a disposable address, send it a message, and read the message back — three requests.
Addresses and the phrase
Why a disposable address refuses mail whose subject lacks its phrase, and how expiry, retention and release differ.

API reference

Red

Regiones
Geographic locations NimbusNexus serves, with live + pre-launch status.
IPs flotantes
Region-scoped public IPs that can be detached from one VM and reattached to another.
Redes
L2 broadcast domains that VMs and load balancers attach to. The base primitive of a project's VPC.
Subredes
IP-address blocks carved out of a network. Each subnet has its own CIDR, gateway, and DHCP policy.
Grupos de seguridad
Stateful firewall rule sets applied to VM network interfaces.
Routers
Connect tenant subnets to the project's external gateway.
Balanceadores de carga
Managed L4 / L7 traffic distribution across a pool of backend VMs.
Network ports
L2/L3 ports on a network. The primitive VM interfaces and load balancers bind to.
Address groups
Named sets of CIDRs reusable across security group rules.
Network sharing
Share a network between projects in the same workspace.
QoS policies
Bandwidth limits, DSCP marking, and minimum-bandwidth guarantees on network ports.

Resources & support

Articles & playbooks
Architecture deep dives, decision guides, and worked examples — for when you want to understand the why, not just the how.
Get help
Open a support ticket, talk to sales, or report a security issue. We answer email; we also pick up the phone for paying customers.