Skip to main content
The Compute with Hivenet API lets you inspect and manage existing Compute resources programmatically instead of working only through the web console. Use these guides to understand the main workflows, then use the API reference for exact endpoint details.
Use the guides for workflow context. Use the API reference for paths, parameters, schemas, and response details.

​
Base URLs

Production: https://api.hivecompute.ai/v1 Staging: https://staging-api.hivecompute.ai/v1 For example, GET /instances becomes: https://api.hivecompute.ai/v1/instances

​
Authentication

Every request requires a bearer API key:
API keys are currently issued manually. Contact support@hivenet.com to request one.
Keep API keys private. Don’t paste them into public issues, shared documents, screenshots, or client-side code.

​
Current API surface

This release contains eight public endpoints: SSH-key endpoints are not part of this release.

​
Regions

The API uses these region values:
  • UAE
  • FR
  • US
Use the value returned by GET /regions when filtering instances or presets.

​
How actions work

Start, stop, and terminate actions are asynchronous. The API can return before the instance reaches its final state. Poll GET /instances/{id} until the status field shows the state you expect.
Terminating an instance is permanent. A terminated instance can’t be restarted, and its data is deleted.

​
What you’ll need

  • A Compute with Hivenet account
  • An API key
  • A terminal, API client, or tool that can send HTTP requests
  • Access to the instance you want to inspect or manage
You don’t need an SDK to get started. A curl request is enough.

​
Where to go next

Start with Make your first API request, then use the endpoint reference for exact request and response details.