API Reference
The Hyperstack API is a REST API for deploying and managing GPU infrastructure on the Hyperstack cloud, provision virtual machines, manage volumes, configure networking, and access billing data programmatically.
https://infrahub-api.nexgencloud.com/v1Pass your API key as the api_key request header (no prefix). See Authentication for key generation and rotation.
Quickstart
Make your first API call and deploy a virtual machine in five minutes.
Resources
Core
Virtual machines, volumes, snapshots, networking, firewalls, clusters, and templates.
Object Storage
S3-compatible storage buckets and access keys.
AI Studio
Base models, inference, fine-tuning jobs, datasets, and model deployment.
Organization & Access
Authentication, API keys, organization membership, RBAC roles, invites, and permissions.
Pricebook
Pricing data, cost calculation, and long-term GPU contracts.
Billing
Credit balances, payments, vouchers, and usage history.
Reference
Authentication
Generate API keys, rotate them, and pass them in requests.
Errors
Status codes, error envelope shape, and common causes.
Pagination
Iterate list endpoints, three observed envelope shapes.
Rate limits
Per-IP limits and backoff guidance for production traffic.
Request and response format
Requests use standard HTTP methods (GET, POST, PUT, PATCH, DELETE). Request bodies are application/json unless noted otherwise on the endpoint. Responses are application/json and follow a consistent envelope of {status, message, .}, see the Pagination primer for the small set of exceptions.
Authentication
- API Key: apiKey
Header-based API-key authentication (default). Pass your API key as the api_key header value (e.g. api_key: YOUR_API_KEY, no prefix). Generate a key in the Hyperstack console. The key is personal to your user account and works across every environment and region in your organization.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | api_key |