AnkraDocs
Console

API

API reference

Every operation of the Ankra Cloud API, generated from its OpenAPI document and grouped by area.

309 operations of API v1. Each area has its own page with every operation's method and path, the credentials and permission it needs, its parameters, request and response schemas and a curl example. Start with the API overview for authentication, errors, pagination and operations.

Compute

Servers

Servers, their lifecycle and operations, plans, templates and the audit log.

Block storage and backups

Block storage, backups and custom images.

SSH keys, init scripts and server groups

SSH keys, init scripts and server groups.

Console, metadata and metrics

The console, the metadata service setting, server metrics and network transfer.

Port forwarding

A TCP stream to a server's SSH port through its zone's gateway, for a client with no route to the server's address (ADR 0017).

High availability and maintenance

High availability and migration policies, node maintenance and operator actions on servers.

Networking

Networks, routers and floating IPs

Private networks, routers, floating IPs, server interfaces and firewalls.

Network edges

Network edges - bastion, NAT64/DNS64 gateway and dual-stack load balancer roles.

VPN gateways

VPN gateways - WireGuard or Headscale (Tailscale clients) into one or more private networks.

Hosted DNS

Hosted DNS - zones on the Ankra Cloud nameservers, delegated subzones and their records.

Load balancers

Managed load balancers and their certificates.

Tunnels

Ankra Tunnel - publish HTTP services that have only outbound connectivity. A tunnel's connector dials the Ankra relay; the relay serves the tunnel's hostnames (in the account's hosted DNS zones, behind the zone's WAF) with certificates it obtains itself and proxies each request to the hostname's origin through the connector.

Managed services

Databases

Managed PostgreSQL databases.

Object storage

Managed object storage.

Managed Kubernetes

Managed Kubernetes - clusters whose control plane is a vCluster Ankra runs on the region's host cluster, their node pools of servers in your account, kubeconfigs and OIDC tokens, etcd snapshots, and the operator's regional host clusters.

Kubernetes in the Ankra platform

A managed Kubernetes cluster's registration in the Ankra platform (ADR 0006): registering it in the account's platform organisation now, and taking it out of the platform. Registration otherwise happens on its own once a cluster runs; its state is platform on the cluster.

Dev clusters

Dev clusters (ADR 0012): Kubernetes for development on one server in the account. The server runs k3s as control plane and only node and is its own network edge: it serves the Kubernetes API (port 6443) and the cluster's ingress (ports 80 and 443) on its own public addresses. Billed as its server; not for production.

Playgrounds

Native playgrounds (ADR 0010): a free, short-lived Kubernetes cluster (a vCluster on the region's host cluster) for every verified account, one at a time and at most the allowance ever; staff list them and end one with a reason.

Account and billing

Usage and invoices

Usage, the billing log and invoices.

Credits and coupons

Account credits, coupon redemption, and credit and coupon management for staff.

Payments

Payment methods and the Stripe webhook.

Quotas

Account quotas.

Quota requests

Requests for higher limits: an account asks for the limits it needs and says why, and Ankra's staff approve, which raises the limits, or decline with a reason the account sees. Nothing but an approval changes a limit.

Outbound email

Abuse handling: whether the account's servers may send on port 25 (new accounts start blocked) and the request that lifts it, the DNS blocklist listings of the platform's public addresses, and the abuse reports staff work. Metadata only: nothing here reads a packet's contents.

Abuse incidents

Abuse incidents raised from connection metadata of a server's outbound traffic (never a payload): port scans, SSH or RDP brute force, outbound floods, spam, contact with botnet command-and-control servers and mining pools. An account reads its own; Ankra's staff tell the account, quarantine the server's network (the server keeps running with its disks), release it or dismiss the incident.

Notifications

What the control plane told the account: an operation failed, the charge for an invoice failed, the account is about to be or was suspended for an overdue invoice, a create was refused by a limit. A notification is read or unread for the whole account. The ones about billing are also sent by email to the account's owner and admins.

Service status

The public status page: incidents and maintenance windows staff publish from the staff console, each with the zones and services it touches and a timeline of updates, and the public feed the status page at ankra.cloud/status is drawn from.

Private cloud

Private cloud: physical hosts dedicated to one account. An account reads the capacity it has per zone (never which machines carry it) and asks for a private cloud or more of it; staff review the requests and dedicate hosts in the fleet.

Projects

The projects of the account's Ankra platform organisation that the caller reaches (ADR 0022). Servers, DNS zones and tunnels belong to a project; the platform owns the projects themselves.

Access and identity

API tokens, members and sessions

API tokens, members, invitations and sessions.

Support access

The customer's control over Ankra support access.

Exposure scanning

External exposure scanning: the control plane connects to commonly exposed ports on the account's public addresses once a day, reads only what each service volunteers, and reports what it found with how to fix it. It notifies and never blocks. On by default; an account may opt out.

Authentication

Customer sign-up, sign-in, sessions, invitations and support handoff.

Identity provider sign-in

Sign-in through the OpenID Connect identity provider.

Password recovery

Password recovery by email - whether it is available, asking for a link, and setting a new password with one.

Password change

A signed-in user replacing their own password after proving the current one.

Email verification

Proving an email address - asking for a verification link and confirming its token.

Linked identities

The signed-in user's linked sign-in identities.

Two-factor authentication

Multi-factor authentication: the second sign-in step (a TOTP code or a recovery code), setting up and turning off an authenticator app, recovery codes, and the account owner's requirement of a second factor for every member.

Support sign-in

Independent Ankra Support identity handoff.

Ankra Platform workspace sync

Workspace organisation sync and server-only delegated membership.

Accounts and Ankra organisations

The accounts you act in and their link to Ankra platform organisations (platform.ankra.app is the primary identity).

Locations and tools

Zones and their capabilities

Node registration (ankra-node) and the operator's view of zones, nodes and gateways.

Regions

Regions (a metro of availability zones within about 2 ms of each other) and, for operators, the racks of a zone (ADR 0003).

Model Context Protocol

The Model Context Protocol endpoints (docs/mcp.md). They carry JSON-RPC messages, not REST resources, and are never MCP tools themselves.