For the complete documentation index, see llms.txt. This page is also available as Markdown.

Platform API

The Platform API for managing Nebula Block instances, SSH keys, API keys, object storage, and billing.

The Platform API manages everything that is not inference: compute instances, SSH keys, API keys, object storage, billing, and teams.

  • Base URL: https://api.nebulablock.com

  • Base path: /api/v1

  • API_URL: https://api.nebulablock.com/api/v1

  • Authentication: Authorization: Bearer <token or API key> — see Authentication

Responses share a common envelope: a data payload, a message string, and a status of success or failed. Some listing endpoints add a meta block for pagination.

Important: Several endpoints report business failures as HTTP 200 with "status": "failed" — a duplicate name, an exceeded quota, or a rejected operation does not necessarily arrive as a 4xx. Check the status field, not just the HTTP status code. Endpoints that behave this way say so.

Compute

Endpoint
Reference

GET /computing/products

GET /computing/images

POST /computing/instance

GET /computing/instances

GET /computing/deleted-instances

GET /computing/instance/{id}

GET /computing/instance/{id}/start

GET /computing/instance/{id}/stop

GET /computing/instance/{id}/reboot

DELETE /computing/instance/{id}

GET /computing/instance/{id}/firewall-rules

POST /computing/instance/{id}/firewall-rules

DELETE /computing/instance/{id}/firewall-rules/{rule_id}

SSH keys

Endpoint
Reference

GET /ssh-keys/

POST /ssh-keys/

PUT /ssh-keys/{id}

DELETE /ssh-keys/{id}

API keys

Endpoint
Reference

GET /keys

POST /keys

PUT /keys/{id}

DELETE /keys/{id}

Billing

Endpoint
Reference

GET /users/credits

GET /users/credits/history

GET /users/invoices

GET /users/invoice-download/{invoice_id}

Object storage

Note: Workspace responses carry a provider field identifying the storage backend, and the console appends a matching provider query parameter to every object storage call. The parameter is not required — the endpoints behave the same without it — but you will see it in browser traffic.

Endpoint
Reference

GET /object-storage/

POST /object-storage/

DELETE /object-storage/

POST /object-storage/regenerate-key-pair

GET /object-storage/buckets

POST /object-storage/bucket

DELETE /object-storage/bucket

GET /object-storage/bucket/files

POST /object-storage/upload

GET /object-storage/download-url

DELETE /object-storage/file

POST /object-storage/buckets/toggle-privacy

GET /object-storage/usage-data

Not yet documented

These endpoints are live but do not have reference pages yet. Their shapes are visible in the console's network traffic, and the guides linked below cover the same features through the UI:

Area
Base path
Guide

Teams, members, roles, and team keys

/teams

Usage and spend summaries

/usage

—

Account notifications

/notifications

—

Webhook configuration

/webhook-configs

—

Hardware store

/hardware

—

Storage workspace details

/object-storage/details

Direct object download

/object-storage/download, /object-storage/download-resource

Get Download URL covers the usual path

See also

Last updated