Introduction

The Anikeen Console API is a REST API for the products you manage in the Anikeen Console: servers, containers, domains, DNS zones, web hosting and load balancers, plus the product catalog and orders.

It acts as you: with your token you see and change exactly what you can see and change in the Console, with the same team permissions. There is no separate API account.

What you can do

Area	What the API offers
Catalog beta	List the orderable products with prices and the choices for each order
Orders beta	Order products like in the Console's builder
Containers beta	Power, reinstall, rename, delete, backups and snapshots
Servers beta	Power, reinstall, rename, delete, backups and snapshots
Domains	Domains, contacts, name servers, glue records, transfers
DNS zones	Zones and their records
Web hosting	Databases, domains, e-mail addresses and accounts, FTP accounts
Load balancers	Backends, frontends, binds and routing rules
Reseller API	End customers, logins, grants, discounts and orders of a reseller team
Webhooks for apps beta	Events for apps that act for their users

There is also a PHP SDK for Laravel apps, anikeen/console.

Beta features

Pages and sections marked beta describe features that are available on the staging environment and are not yet released to production. They may still change.

Base URL

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

All paths in this documentation are relative to the base URL. Staging only accepts tokens of staging Anikeen ID (staging.id.anikeen.com).

Conventions

• JSON everywhere. Send Accept: application/json and, with a body, Content-Type: application/json. Errors are always JSON (see Errors).
• IDs. Products, orders and teams are addressed by their id (a ULID such as 01JC…).
• PUT and PATCH. Where the API takes PUT, it also accepts PATCH.
• Pagination. Lists are paginated: pass ?page=2; the response holds data, current_page, last_page and further paging fields.

{
  "current_page": 1,
  "data": [ … ],
  "last_page": 3,
  …
}

• Background operations. Long operations (power actions, reinstalls, backups, snapshots) answer 202 Accepted with {"message": "…"} and run in the background. Read the object again to see the result.

Next steps

• Getting started: create a token and make your first request.
• Authentication & tokens: which tokens the API accepts.
• Scopes: what each scope opens.