API
API reference
Every operation of the Ankra Cloud API, generated from its OpenAPI document and grouped by area.
244 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.
- GET/v1/audit
- GET/v1/audit/export
- GET/v1/audit/integrity
- GET/v1/operations/{id}
- GET/v1/plans
- GET/v1/servers
- POST/v1/servers
- GET/v1/servers/{id}
- PATCH/v1/servers/{id}
- DELETE/v1/servers/{id}
- GET/v1/servers/{id}/console
- POST/v1/servers/{id}/plan
- POST/v1/servers/{id}/rebuild
- POST/v1/servers/{id}/renumber-ipv6
- POST/v1/servers/{id}/restart
- POST/v1/servers/{id}/start
- POST/v1/servers/{id}/stop
- GET/v1/templates
Block storage and backups
Block storage, backups and custom images.
- GET/v1/backups
- GET/v1/backups/{id}
- DELETE/v1/backups/{id}
- POST/v1/backups/{id}/restore
- GET/v1/custom-images
- DELETE/v1/custom-images/{id}
- POST/v1/custom-images/{id}/copy
- GET/v1/snapshots/{id}
- DELETE/v1/snapshots/{id}
- GET/v1/storage-tiers
- GET/v1/storages
- POST/v1/storages
- GET/v1/storages/{id}
- PATCH/v1/storages/{id}
- DELETE/v1/storages/{id}
- POST/v1/storages/{id}/attach
- POST/v1/storages/{id}/backups
- POST/v1/storages/{id}/detach
- POST/v1/storages/{id}/move
- POST/v1/storages/{id}/resize
- GET/v1/storages/{id}/snapshots
- POST/v1/storages/{id}/snapshots
- POST/v1/storages/{id}/templatize
SSH keys, init scripts and server groups
SSH keys, init scripts and server groups.
- GET/v1/init-scripts
- POST/v1/init-scripts
- GET/v1/init-scripts/{id}
- PATCH/v1/init-scripts/{id}
- DELETE/v1/init-scripts/{id}
- GET/v1/server-groups
- POST/v1/server-groups
- GET/v1/server-groups/{id}
- PATCH/v1/server-groups/{id}
- DELETE/v1/server-groups/{id}
- GET/v1/ssh-keys
- POST/v1/ssh-keys
- GET/v1/ssh-keys/{id}
- PATCH/v1/ssh-keys/{id}
- DELETE/v1/ssh-keys/{id}
Console, metadata and metrics
The console, the metadata service setting, server metrics and network transfer.
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.
- GET/v1/floating-ips
- POST/v1/floating-ips
- GET/v1/floating-ips/{id}
- DELETE/v1/floating-ips/{id}
- POST/v1/floating-ips/{id}/assign
- GET/v1/networks
- POST/v1/networks
- GET/v1/networks/{id}
- PATCH/v1/networks/{id}
- DELETE/v1/networks/{id}
- GET/v1/routers
- POST/v1/routers
- GET/v1/routers/{id}
- PATCH/v1/routers/{id}
- DELETE/v1/routers/{id}
- POST/v1/routers/{id}/networks
- DELETE/v1/routers/{id}/networks/{network}
- GET/v1/servers/{id}/firewall
- PUT/v1/servers/{id}/firewall
- GET/v1/servers/{id}/networks
- POST/v1/servers/{id}/networks
- DELETE/v1/servers/{id}/networks/{network}
Network edges
Network edges - bastion, NAT64/DNS64 gateway and dual-stack load balancer roles.
Hosted DNS
Hosted DNS - zones on the Ankra Cloud nameservers, delegated subzones and their records.
- GET/v1/dns/zones
- POST/v1/dns/zones
- GET/v1/dns/zones/{id}
- DELETE/v1/dns/zones/{id}
- GET/v1/dns/zones/{id}/records
- POST/v1/dns/zones/{id}/records
- PATCH/v1/dns/zones/{id}/records/{record_id}
- DELETE/v1/dns/zones/{id}/records/{record_id}
- POST/v1/dns/zones/{id}/records/bulk-delete
- GET/v1/dns/zones/{id}/subzones
- POST/v1/dns/zones/{id}/subzones
- POST/v1/dns/zones/{id}/sync
Load balancers
Managed load balancers and their certificates.
- GET/v1/load-balancers
- POST/v1/load-balancers
- GET/v1/load-balancers/{id}
- PATCH/v1/load-balancers/{id}
- DELETE/v1/load-balancers/{id}
- POST/v1/load-balancers/{id}/backends
- PATCH/v1/load-balancers/{id}/backends/{backend}
- DELETE/v1/load-balancers/{id}/backends/{backend}
- PUT/v1/load-balancers/{id}/backends/{backend}/members
- POST/v1/load-balancers/{id}/backends/{backend}/members
- PATCH/v1/load-balancers/{id}/backends/{backend}/members/{member}
- DELETE/v1/load-balancers/{id}/backends/{backend}/members/{member}
- POST/v1/load-balancers/{id}/frontends
- DELETE/v1/load-balancers/{id}/frontends/{frontend}
- GET/v1/load-balancers/certificates
- POST/v1/load-balancers/certificates
- GET/v1/load-balancers/certificates/{certificate}
- DELETE/v1/load-balancers/certificates/{certificate}
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.
- GET/v1/kubernetes-clusters
- POST/v1/kubernetes-clusters
- GET/v1/kubernetes-clusters/{id}
- DELETE/v1/kubernetes-clusters/{id}
- GET/v1/kubernetes-clusters/{id}/etcd-snapshots
- POST/v1/kubernetes-clusters/{id}/etcd-snapshots
- GET/v1/kubernetes-clusters/{id}/kubeconfig
- GET/v1/kubernetes-clusters/{id}/node-pools
- POST/v1/kubernetes-clusters/{id}/node-pools
- GET/v1/kubernetes-clusters/{id}/node-pools/{pool}
- PATCH/v1/kubernetes-clusters/{id}/node-pools/{pool}
- DELETE/v1/kubernetes-clusters/{id}/node-pools/{pool}
- POST/v1/kubernetes-clusters/{id}/restore
- GET/v1/kubernetes-clusters/{id}/token
- POST/v1/kubernetes-clusters/{id}/upgrade
- GET/v1/kubernetes-clusters/versions
- GET/v1/kubernetes-oidc/.well-known/openid-configuration
- GET/v1/kubernetes-oidc/keys
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.
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.
Access and identity
API tokens, members and sessions
API tokens, members, invitations and sessions.
Support access
The customer's control over Ankra support access.
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.
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.
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.