O mascote urso-polar do NordBastion sentado em uma estação de trabalho de controle de missão tática com monitores de terminal holográficos flutuantes mostrando código ciano, um teclado mecânico com teclas iluminadas em ciano e o escudo-N ciano apoiado ao lado dele, dentro de uma sala de console de pedra Nórdica exposta com uma janela iluminada por aurora

API.v1 · REST · 70+ endpoints · 5 SDKs

Execute o NordBastion pelo código.
KYC-free, pago em cripto, totalmente scriptável.

Provisione servidores, tire snapshots, recarregue em criptomoeda, execute ping de qualquer bastion. Cada ação do painel tem um endpoint REST e quatro SDKs. Mesmo piso de identidade do painel: um e-mail e uma senha, nada mais.

Início rápido Todos os endpoints

Versão: v1
Endpoints: 70+
SDKs: 4 + CLI
Bastões: 4 Nordic
Limite de taxa: 1000/min read
KYC: Nenhum

Início rápido

Três etapas de uma conta cadastrada a um servidor inicializado em código.

01 Create an account

POST /v1/auth/register

Email + password, no KYC. Returns a 24-hour access token straight away — no email confirmation step.

curl -sS https://nordbastion.com/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","password":"••••••••••••"}'

02 Recarregue em cripto

POST /v1/billing/topups

Open a per-coin invoice. The response carries a deposit address, QR code and expiry timestamp.

amount_usd must be between $30 and $10,000 (server-enforced). Lower returns HTTP 422 amount_too_low, higher returns amount_too_high.

curl -sS https://nordbastion.com/v1/billing/topups \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"amount_usd":50,"coin":"xmr"}'

03 Provisionar um servidor

POST /v1/servers

Pick a tier (service_code), a bastion and an image. Server is booted with SSH in about ninety seconds.

curl -sS https://nordbastion.com/v1/servers \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"service_code":"NB-V3","bastion":"STO","image":"debian-12"}'

SDKs & CLI

Quatro linguagens, um binário.

Cada SDK é licenciado MIT, com código-fonte disponível, semanticamente versionado e estável a partir da v1.0. Todos compartilham a mesma interface de cliente autenticado — listar servidores, em qualquer linguagem.

Planned for v1.1

These SDKs are planned for v1.1. The REST API at /v1/* is fully usable from any HTTP client today — see the agents page for cURL and MCP examples.

Python

pip

pip install nordbastion

from nordbastion import Client
nb = Client(api_key="nb_live_••••")

for s in nb.servers.list():
    print(s.id, s.name, s.status)

TypeScript

npm

npm i @nordbastion/api

import { NordBastion } from '@nordbastion/api';
const nb = new NordBastion({ apiKey: 'nb_live_••••' });

const servers = await nb.servers.list();
servers.forEach(s => console.log(s.id, s.name, s.status));

Go

go install

go get go.nordbastion.com/api

import nb "go.nordbastion.com/api"

c := nb.New(nb.WithAPIKey("nb_live_••••"))
servers, _ := c.Servers.List(ctx)
for _, s := range servers {
    fmt.Println(s.ID, s.Name, s.Status)
}

Rust

cargo

cargo add nordbastion

use nordbastion::Client;
let nb = Client::builder()
    .api_key("nb_live_••••").build()?;

for s in nb.servers().list().await? {
    println!("{} {} {}", s.id, s.name, s.status);
}

CLI · nb

Planned for v1.1

curl -sSL https://get.nordbastion.com | sh

nb auth login --api-key nb_live_••••
nb servers list
nb servers create --tier NB-V3 --bastion STO
nb servers snap NB-srv-1234 --name pre-upgrade

Curl primeiro

A API REST funciona com qualquer cliente HTTP. Corpos de requisição e resposta JSON, bearer JWT ou chave de API com escopo, payloads de webhook assinados. Sem lock-in de SDK.

curl -H "Authorization: Bearer nb_live_••••" https://nordbastion.com/v1/servers

Referência de endpoints

70+ endpoints em doze grupos de recursos.

Authentication · 14 endpoints

POST	/v1/auth/register LIVE	Create a NordBastion account from email + password (no KYC).
POST	/v1/auth/login LIVE	Exchange email + password for a bearer token. Returns 24-hour JWT.
POST	/v1/auth/login/totp LIVE	Second step when the account has TOTP 2FA enabled.
POST	/v1/auth/token/refresh LIVE	Rotate a bearer token without re-entering credentials.
POST	/v1/auth/recover LIVE	Initiate account recovery (PGP-based, stubbed in v1.0).
GET	/v1/auth/sessions LIVE	List active sessions for the current account.
DELETE	/v1/auth/sessions/{token_id} LIVE	Revoke a session by token ID (logout-everywhere).
POST	/v1/auth/totp/setup LIVE	Begin TOTP enrollment — returns the provisioning URI.
POST	/v1/auth/totp/enable LIVE	Confirm a TOTP code and enable 2FA.
POST	/v1/auth/totp/disable LIVE	Disable 2FA with a current TOTP code.
POST	/v1/auth/password LIVE	Change the account password.
POST	/v1/auth/api-keys LIVE	Create a scoped, long-lived API key (read · billing · servers · full).
GET	/v1/auth/api-keys LIVE	List API keys for the current account (last-used + scopes).
DELETE	/v1/auth/api-keys/{key_id} LIVE	Revoke an API key immediately.

Account · 5 endpoints

GET	/v1/account LIVE	Get the authenticated account (email, status, locale, 2FA state).
PATCH	/v1/account LIVE	Update email, password, locale, default bastion preference.
GET	/v1/account/balance LIVE	Current prepaid balance in USD.
GET	/v1/account/usage LIVE	Trailing-30-day API usage totals.
GET	/v1/account/audit-log LIVE	Recent authenticated requests for this account.

Billing & crypto top-ups · 8 endpoints

POST	/v1/billing/topups LIVE	Create a top-up intent. Returns a per-coin address + QR + expiry.
GET	/v1/billing/topups LIVE	List pending and confirmed crypto top-ups.
GET	/v1/billing/topups/{order_number} LIVE	Status of a single top-up (confirmations, settle status).
POST	/v1/billing/topups/{order_number}/cancel LIVE	Cancel a still-open top-up.
GET	/v1/billing/bonus-tiers LIVE	Public top-up bonus tier ladder.
GET	/v1/billing/coins LIVE	12 supported cryptocurrencies + current settle threshold per coin.
GET	/v1/billing/invoices PLANNED	List invoices (monthly statements).	roadmap
GET	/v1/billing/invoices/{id} PLANNED	Single invoice. Format: JSON · PDF · PGP-signed PDF.	roadmap

Catalogue · 7 endpoints

GET	/v1/catalog LIVE	Bundle of all catalog resources in one call.
GET	/v1/catalog/vps LIVE	Five VPS tiers — Sentinel · Garrison · Ravelin · Bulwark · Citadel.
GET	/v1/catalog/dedicated LIVE	Five dedicated tiers — Bastion-Lite to Bastion-Hyperion.
GET	/v1/catalog/bastions LIVE	Four Nordic bastions — STO · HEL · OSL · RKV with live status.
GET	/v1/catalog/images LIVE	Default OS images — Debian · Ubuntu · Alpine · Arch · FreeBSD · Win.
GET	/v1/catalog/{code} LIVE	Lookup a single tier by service_code.
GET	/v1/catalog/iso PLANNED	Library of bootable ISO images for custom installs.	roadmap

Servers · 14 endpoints

POST	/v1/servers LIVE	Provision a new VPS or dedicated server. Returns 202 + order_number.
GET	/v1/servers LIVE	List servers — supports filter, sort, paginate, field selection.
GET	/v1/servers/{order_number} LIVE	Single server with full configuration + current status.
PATCH	/v1/servers/{order_number} LIVE	Mutate a server (hostname only in v1.0).
DELETE	/v1/servers/{order_number} LIVE	Cancel / decommission a server. Pro-rated credit returned.
POST	/v1/servers/{id}/power PLANNED	Start · stop · restart · poweroff · acpi-shutdown.	roadmap
POST	/v1/servers/{id}/reinstall PLANNED	Reinstall OS from any catalogue image or custom template.	roadmap
POST	/v1/servers/{id}/rescue PLANNED	Reboot into rescue mode (Alpine ramdisk · 1 hour timeout).	roadmap
POST	/v1/servers/{id}/resize PLANNED	Move a VPS up or down between tiers. Applies on next reboot.	roadmap
POST	/v1/servers/{id}/migrate PLANNED	Redeploy a snapshot to another bastion. Pin to STO · HEL · OSL · RKV.	roadmap
POST	/v1/servers/{id}/password-reset PLANNED	Reset root password. Returned once, never stored.	roadmap
GET	/v1/servers/{id}/metrics PLANNED	Per-minute CPU · RAM · disk · network for the last 90 days.	roadmap
GET	/v1/servers/{id}/console PLANNED	One-time URL to the web VNC/SPICE console (expires 5 min).	roadmap
GET	/v1/servers/{id}/serial PLANNED	One-time URL to the web serial console (expires 5 min).	roadmap

Snapshots · 5 endpoints

POST	/v1/servers/{id}/snapshots PLANNED	Create a live or quiesced snapshot (off-host, encrypted).	roadmap
GET	/v1/servers/{id}/snapshots PLANNED	List snapshots for a server (size, age, source).	roadmap
POST	/v1/servers/{id}/snapshots/{snapId}/restore PLANNED	Restore in place — server reboots into the snapshot.	roadmap
DELETE	/v1/servers/{id}/snapshots/{snapId} PLANNED	Delete a snapshot.	roadmap
POST	/v1/servers/{id}/snapshots/{snapId}/export PLANNED	Export a snapshot as a .qcow2 download. PGP-signed manifest.	roadmap

SSH keys · 4 endpoints

POST	/v1/ssh-keys LIVE	Register a new SSH public key. SHA-256 fingerprint indexed.
GET	/v1/ssh-keys LIVE	List SSH keys on the account.
GET	/v1/ssh-keys/{id} LIVE	A single SSH public key.
DELETE	/v1/ssh-keys/{id} LIVE	Remove a key (does not change any existing server's installed keys).

Networking · 8 endpoints

GET	/v1/networking/ips PLANNED	List IPv4 + IPv6 addresses assigned to your servers.	roadmap
POST	/v1/networking/ips/floating PLANNED	Request additional IPv4 or a /64 IPv6 block. Bastion-scoped.	roadmap
POST	/v1/networking/rdns PLANNED	Set reverse-DNS PTR. IPv4 + IPv6 supported.	roadmap
POST	/v1/networking/firewall PLANNED	Create or replace a firewall ruleset for one or more servers.	roadmap
GET	/v1/networking/firewall PLANNED	List firewall rulesets and their bindings.	roadmap
POST	/v1/networking/private-network PLANNED	Create a VPC-style private network between your own servers.	roadmap
POST	/v1/networking/byoip PLANNED	Announce your own /24 (IPv4) or /48 (IPv6). RPKI-verified.	roadmap
POST	/v1/networking/lookingglass PLANNED	Run ping · traceroute · MTR from any of the four bastions.	roadmap

Storage · 5 endpoints

POST	/v1/storage/volumes PLANNED	Provision an additional NVMe volume — 10 GB to 16 TB, bastion-scoped.	roadmap
GET	/v1/storage/volumes PLANNED	List volumes on the account.	roadmap
POST	/v1/storage/volumes/{id}/attach PLANNED	Attach a volume to a running or stopped server.	roadmap
POST	/v1/storage/volumes/{id}/detach PLANNED	Detach a volume (requires the server to be stopped).	roadmap
POST	/v1/storage/volumes/{id}/resize PLANNED	Grow a volume. Shrink not supported.	roadmap

Images & templates · 3 endpoints

POST	/v1/images/iso/upload PLANNED	Upload a custom .iso (≤ 4 GB) bootable from any server's rescue path.	roadmap
POST	/v1/images/templates PLANNED	Register a custom OS template from an existing snapshot.	roadmap
GET	/v1/images/templates PLANNED	List your custom templates.	roadmap

Webhooks · 4 endpoints

POST	/v1/webhooks LIVE	Subscribe a URL to one or more event types. HMAC-signed payloads.
GET	/v1/webhooks LIVE	List webhook subscriptions on the account.
DELETE	/v1/webhooks/{id} LIVE	Remove a webhook subscription.
POST	/v1/webhooks/{id}/test LIVE	Send a synthetic test event to a webhook URL.

Transparency · 4 endpoints

GET	/v1/transparency/canary LIVE	Current warrant canary, PGP-signed payload. Same content as /warrant-canary/.
GET	/v1/transparency/peering LIVE	AS213232 peering announcements + current prefix list.
GET	/v1/transparency/status LIVE	Live operational status of every bastion + shared services.
GET	/v1/transparency/incidents PLANNED	Operational incidents (last 12 months, rolling).	roadmap

Agents directory · 2 endpoints

GET	/v1/agents/directory LIVE	Public listing of agents using NordBastion.
POST	/v1/agents/directory LIVE	Submit this account's agent for the public directory.

OAuth 2.1 / DCR · 4 endpoints

POST	/v1/oauth/register LIVE	RFC 7591 Dynamic Client Registration.
POST	/v1/oauth/token LIVE	Token endpoint — client_credentials, password, refresh_token.
POST	/v1/oauth/revoke LIVE	Revoke an access or refresh token.
GET	/v1/oauth/introspect LIVE	Introspect a token (RFC 7662, basic info only).

Todos os endpoints seguem JSON de entrada / JSON de saída, paginação por ?page= & ?per_page=, filtragem por ?filter[field]= e seleção de campos por ?fields=. Toda requisição pode carregar um cabeçalho Idempotency-Key.

Autenticação

Três tipos de credencial, dois modos de privacidade.

Token Bearer LIVE

E-mail + senha · JWT · expiração em 24 horas

JWT de curta duração emitido por POST /v1/auth/login. Carrega claims de escopo e um ID de revogação de sessão. Renovável por 30 dias via /v1/auth/token/refresh.

Authorization: Bearer eyJhbGciOi••••

Chave de API com escopo LIVE

Duradouro · com escopo · revogável

Escopos: read-only, billing-read, billing-write, servers-read, servers-write, full. Lista de IPs permitidos opcional (CIDR), expiração opcional. Recomendado para CI e scripts de infraestrutura.

Authorization: Bearer nb_live_3f9c2a••••

TLS mútuo Planned v1.1

Certificado de cliente · empresarial / conformidade

Vincule um certificado de cliente mTLS a uma chave de API. As requisições que apresentam o certificado de cliente errado são rejeitadas na camada TLS antes que qualquer lógica de aplicação seja executada. Disponível sob solicitação pelo painel.

curl --cert client.pem --key client.key https://nordbastion.com/v1/servers

Respostas assinadas com PGP Planned v1.1

Assinatura destacada opt-in · verificável offline

Defina X-NB-Sign: 1 em qualquer requisição. O corpo da resposta é envolvido em uma assinatura PGP cleartext destacada usando a chave NordBastion (fingerprint em /pgp/). Utilizado por pipelines de conformidade que não confiam apenas na cadeia TLS.

curl -H "X-NB-Sign: 1" -H "Authorization: Bearer ..." https://nordbastion.com/v1/transparency/canary

A NordBastion não coleta identidade no cadastro, e a API não muda esse piso. Não há webhook de verificação por SMS, nenhum fluxo de confirmação por e-mail, nenhum endpoint de upload de documento de identidade. A API expõe dinheiro, máquinas e metadados — essa é toda a superfície.

Limites de taxa

Por chave, publicado por minuto

Endpoints de leitura: 1000 / min
Endpoints de escrita: 100 / min
Sensível à autenticação: 10 / min
Tentativa após erro 429: Retry-After

Cada resposta carrega X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Tiers mais altos estão disponíveis sob solicitação no painel.

Versionamento

Piso de depreciação de doze meses

Os endpoints são versionados por URL em /v1/. Mudanças incompatíveis só são lançadas em uma nova versão principal. A versão principal anterior permanece suportada por pelo menos doze meses. Endpoints obsoletos carregam cabeçalhos de resposta Sunset e Deprecation.

Sunset: Wed, 01 Jul 2027 00:00:00 GMT
Deprecation: true

Formato de erro

Envelope estável, código legível por máquina

{
  "error": {
    "type":    "invalid_request",
    "code":    "invalid_bastion",
    "message": "Unknown bastion 'mxp'.",
    "request_id": "req_2VqK8e...",
    "doc_url": "https://nordbastion.com/api/#errors"
  }
}

Webhooks

Eventos assinados, com retentativas e backoff.

Cada payload de evento é assinado com HMAC usando seu segredo de webhook. Três tentativas de reenvio com backoff exponencial em uma hora, depois descartado. Entregas de teste disponíveis em POST /v1/webhooks/{id}/test.

account.balance.low

Balance dropped below the configured threshold.

topup.created

Crypto top-up address generated, waiting for first confirmation.

topup.confirmed

Top-up settled on-chain. Balance credited.

topup.failed

Top-up address expired without confirmation.

invoice.issued

Monthly invoice issued. PDF + PGP-signed PDF available.

server.provisioning

Provisioning started — image being written.

server.provisioned

Server is booted and reachable on SSH.

server.power.on

Server powered on (manual or scheduled).

server.power.off

Server powered off (manual or scheduled).

server.reinstalled

OS reinstalled. Root password rotated.

server.resized

VPS tier changed. Applied on the next reboot.

server.migrated

Server moved to another bastion via snapshot redeploy.

server.deleted

Server terminated. Pro-rated credit returned.

snapshot.created

Snapshot completed and is downloadable.

snapshot.restored

Snapshot restored in place.

snapshot.deleted

Snapshot removed.

volume.attached

Block volume attached to a server.

volume.detached

Block volume detached.

firewall.changed

Firewall ruleset applied to one or more servers.

canary.updated

Warrant canary reaffirmed (first of every month).

incident.opened

Operational incident opened on a bastion or shared service.

incident.resolved

Operational incident closed.

peering.changed

AS213232 peering or prefix announcement updated.

Endpoints de transparência

Acesso programático ao canário, ao log de incidentes, ao registro de peering.

A maioria das APIs de nuvem expõe produtos e cobrança. A NordBastion também expõe sua própria superfície de transparência — programaticamente. O mesmo warrant canary publicado em /warrant-canary/ está disponível como payload JSON assinado em /v1/transparency/canary. O mesmo histórico de incidentes que alimenta /status/ está em /v1/transparency/incidents. O mesmo registro de peering que vive em /peering/ está em /v1/transparency/peering. Os mesmos anúncios de prefixo AS213232 são consultáveis em tempo real.

Inscreva-se no webhook canary.updated e você receberá uma notificação push no primeiro dia de cada mês — se ele parar de disparar, o canário está comprometido, e você saberá sem precisar fazer polling. Construa o alerta você mesmo, em sua própria infraestrutura, com a assinatura criptográfica que você pode verificar offline contra a chave PGP publicada.

Esta é a parte da API que nenhuma cloud comercial possui, porque nenhuma cloud comercial tem a doutrina para respaldá-la.

Exemplo · GET /v1/transparency/canary

{
  "as_of": "2026-05-01T00:00:00Z",
  "statement": "NordBastion has received no...",
  "signature": "-----BEGIN PGP SIGNATURE-----...",
  "key_fingerprint": "B9BB 3413 6FDC C3DA 8356 50C8 1A32 1442 3855 B282",
  "next_reaffirmation": "2026-06-01T00:00:00Z"
}

Leia a página canário Leia o relatório de transparência A chave PGP

FAQ · API

Perguntas de desenvolvedores, respondidas.

As perguntas que um desenvolvedor faz antes de comprometer infraestrutura à API de um host.

Existe realmente uma API e ela é KYC-free?

Sim — toda ação que você pode realizar no painel de controle tem um equivalente na API hoje ou no roadmap publicado, e a própria API é protegida pela mesma conta autenticada do painel: um e-mail e uma senha. Nenhuma verificação de identidade é necessária para obter ou usar credenciais da API.

Quais linguagens de programação têm SDKs oficiais?

Quatro SDKs oficiais e um CLI. Python (pip install nordbastion), TypeScript / Node (npm install @nordbastion/api), Go (go install go.nordbastion.com/cli/nb@latest), Rust (cargo add nordbastion) e um CLI multiplataforma de binário único (nb) instalável via curl. Todos os SDKs são licenciados MIT e com código-fonte disponível.

Posso recarregar meu saldo a partir de código, em criptomoeda?

Sim. POST /v1/billing/topups cria uma intenção de recarga e retorna um endereço de destino por moeda, QR code e timestamp de expiração. Quando a rede confirma o pagamento, seu saldo pré-pago é creditado automaticamente e um webhook topup.confirmed dispara. Doze criptomoedas são suportadas, listadas em /v1/billing/coins.

Os endpoints da API são acessíveis pelo Tor?

O endpoint clearnet api.nordbastion.com é compatível com Tor hoje sem limites de taxa especiais ou bloqueio anti-Tor. Um espelho onion v3 da superfície da API está no roadmap do painel e compartilhará o mesmo material certificado TLS via cabeçalhos de resposta Onion-Location quando for lançado.

O que significa "respostas assinadas com PGP"?

Você pode optar por ativar corpos de resposta assinados com PGP na sua chave de API. Cada resposta JSON é envolvida em uma assinatura PGP cleartext destacada usando a chave NordBastion (fingerprint em /pgp/). O envoltório é verificável offline e é útil para conformidade e atestação de fonte em ambientes que desconfiam apenas da cadeia TLS.

Como os limites de taxa são aplicados?

Por chave de API. A linha base publicada é de 1000 requisições de leitura por minuto e 100 requisições de escrita por minuto, mais 10 requisições por minuto em endpoints sensíveis à autenticação (login, redefinição de senha, criação de chave). Cada resposta carrega os cabeçalhos X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset; respostas 429 incluem um cabeçalho Retry-After. Contas de desenvolvedor verificadas podem solicitar tiers mais altos pelo painel.

Como o versionamento funciona?

Os endpoints são versionados por URL em /v1/. Mudanças incompatíveis só são lançadas em uma nova versão principal (/v2/, /v3/) e a versão principal anterior permanece suportada por pelo menos doze meses após o lançamento da próxima. Endpoints obsoletos carregam um cabeçalho Sunset com a data de corte e um cabeçalho Deprecation: true em cada resposta.

Por que o log de auditoria é opt-in?

Porque a doutrina da NordBastion diz que registramos apenas o que precisamos. As métricas de requisição operacional vivem na janela deslizante que o limitador de taxa precisa e então expiram; um log de auditoria por cliente de ações de API é mais dados do que precisamos para operar a plataforma, portanto está desativado por padrão. Os clientes que quiserem podem ativar /v1/account/audit-log; uma vez ativado, cobre painel + API igualmente e pode ser exportado.

Pronto para automatizar

Obtenha uma chave de API no painel.

O mesmo piso de e-mail e senha do painel. Sem verificação de identidade. Pague em crypto. Inicialize um servidor em Stockholm, Helsinki, Oslo ou Reykjavík em aproximadamente noventa segundos.

Obter chave de API Ver catálogo de VPS Ler a doutrina

URL base · https://nordbastion.com/v1/ · Estado · status operacional em tempo real · Looking glass · execute ping/MTR em tempo real