Skip to content

API reference

Script your cloud — deploy, start, stop, rebuild, delete, all over HTTPS.

Keys and scopes

API keys are created under API & Keys. Keys are shown once at creation and carry a ncak_ prefix so you can spot them in logs. The current scope is maintain — the same reach as the console. Fine-grained scopes arrive with the API.

Sending a request

$ curl -s https://api.nairacloud.com/v1/instances \
    -H "Authorization: Bearer ncak_…"

Every response is JSON. Errors carry a stable machine code on code and a sentence on message.

Lifecycle

  • POST /v1/instances — deploy (plan, os, key, hostname).
  • GET /v1/instances — list. Each instance: id, hostname, status, ip, plan, region.
  • POST /v1/instances/:id/start | /stop | /rebuild — lifecycle.
  • DELETE /v1/instances/:id — delete after confirmation.

The full OpenAPI reference is auto-generated and lands the day the API does. Until then the console dashboard exercises the same contract.