API reference

All paths are relative to the base URL:

Environment	Base URL
Production	https://console.anikeen.com/api/v1
Staging	https://staging.console.anikeen.com/api/v1

Every request needs a bearer token (see Authentication). Lists are paginated (?page=), PUT also accepts PATCH, and long operations answer 202 and run in the background (see Conventions).

Endpoints at a glance

Ordering beta

Method	Path	Page
GET	/catalog	Catalog
GET	/app-team	Apps acting for users
GET	/teams/{team}/orders	Orders
POST	/teams/{team}/orders	Orders
GET	/teams/{team}/orders/{order}	Orders

Products

Family	Base path	Scope family	Page
Containers beta	/containers	console-containers	Containers
Servers beta	/servers	console-servers	Servers
Domains	/domains, /contacts	console-domains	Domains
DNS zones	/zones	console-zones	DNS zones
Web hosting	/hostings	console-hosting	Web hosting
Load balancers	/load-balancers	console-load-balancers	Load balancers

Resellers

Base path	Page
/reseller/teams/{team}/…	Reseller API

Access to objects

• You see the products of your teams (as owner or member) and the products granted to you by a reseller. Objects you cannot see answer 404, not 403.
• What you may do with an object follows the Console's permissions. Team members may do everything; a reseller's end customer may do what its grant level allows (view, console, power, manage). Deleting is for the team only. Otherwise the API answers 403.
• Servers and containers suspended for an unpaid invoice cannot be started, rebooted or reinstalled (409; servers add error: billing_suspended).
• A product that is still being set up can only be read; everything else answers 409, error: provisioning (see below).

Products being set up beta

A product exists as soon as its order is provisioned, but setting up its remote part - the server or container on its host, the domain at the registry, the hosting account, the bucket, a floating IP on its server - can take a few minutes. Every product object carries provisioning_status:

provisioning_status	Meaning
null	ready
provisioning	still being set up
failed	the setup did not finish in time; Anikeen support is informed and finishes or removes it

While it is not null:

• GET works; a family's status field (servers, containers) is provisioning.
• Every other request on the product (power, reinstall, rescale, backups, snapshots, console, name servers, DNS records, delete, …) answers 409 with error: provisioning.
• In the Console the product shows Being set up in its list and cannot be opened yet.

Wait for the product.ready webhook or poll GET until provisioning_status is null. DNS zones and load balancers are ready when they are created and have no such state.