Getting started

This page takes you from zero to your first API request in a few minutes.

1. Sign in to the Console once

The API finds you by your Anikeen ID account. Your Console account must be linked to it: sign in to the Console with Anikeen ID at least once. Your e-mail address must be verified.

2. Create a personal access token

In Anikeen ID, open Settings → API → personal access token and create a token (staging: staging.id.anikeen.com).

Pick a scope that fits what you want to do:

You want to…	Scope
read and change everything you can access in the Console	user
only read	user:read
only read your products	products:read
work with one product family only (e.g. DNS zones) beta	console-zones (or console-zones:read)

All scopes are explained on Scopes. The token is shown once - store it safely. It expires after 6 months.

3. Make your first request

List your DNS zones:

export ANIKEEN_TOKEN="eyJ0eXAiOiJKV1Qi…"

curl https://console.anikeen.com/api/v1/zones \
  -H "Authorization: Bearer $ANIKEEN_TOKEN" \
  -H "Accept: application/json"

You get a paginated list:

{
  "current_page": 1,
  "data": [
    { "id": "01JC…", "name": "example.com", … }
  ],
  "last_page": 1,
  …
}

4. Next: order something beta

1. Look at the catalog - GET /catalog?team={team} lists the products you can order for a team, with the choices for each order (locations, images, networks, SSH keys, …).
2. Place an order - POST /teams/{team}/orders with an Idempotency-Key.
3. As team owner, open the returned checkout_url and confirm the order on Anikeen ID.
4. Poll the order until it is completed and its items are provisioned.

Using PHP?

The Laravel SDK anikeen/console beta handles the tokens, orders, containers and webhooks for you:

use Anikeen\Console\Facades\AnikeenConsole;

$console = AnikeenConsole::withToken(env('ANIKEEN_TOKEN'));

foreach ($console->containers()->list() as $container) {
    echo $container->name, PHP_EOL;
}