Introduction

​

Quickstart

​

1) Generate an API token

1. Click your profile avatar (bottom‑left) in the Ankra dashboard.
2. Profile → API Tokens → Add Token.
3. Name the token, set permissions (if applicable), and copy it somewhere safe.

You won’t be able to view the token again after closing the dialog.

​

2) Make your first request

export ANKRA_API_TOKEN="<your-token>"

curl -sS \
  -H "Authorization: Bearer $ANKRA_API_TOKEN" \
  -H "Accept: application/json" \
  https://platform.ankra.app/api/v1/clusters

import requests

headers = {"Authorization": "Bearer <your-token>"}
resp = requests.get("https://platform.ankra.app/api/v1/clusters", headers=headers)
resp.raise_for_status()
print(resp.json())

const res = await fetch("https://platform.ankra.app/api/v1/clusters", {
  headers: { Authorization: "Bearer <your-token>" }
});
if (!res.ok) throw new Error(await res.text());
console.log(await res.json());

​

Authentication

Authorization: Bearer <your-token>

• Tokens are created in the dashboard and may be scoped (if your organisation uses scoped tokens).
• Revoke tokens anytime from Profile → API Tokens.
• Prefer separate tokens for different use cases (e.g., CLI vs. CI/CD).

​

Security best practices

• Treat tokens like passwords - never commit them to source control.
• Grant only the minimum required permissions.
• Rotate/revoke tokens regularly and immediately if you suspect compromise.
• Store tokens as secrets in your CI/CD system (e.g., GitHub Actions, GitLab CI, Jenkins).

export ANKRA_API_TOKEN="<your-token>"

env:
  ANKRA_API_TOKEN: ${{ secrets.ANKRA_API_TOKEN }}

​

Errors

​

Pagination & filtering

​

Versioning

​

Help & support

• Check the endpoint pages for required parameters and examples.
• Review token permissions if you receive 401/403 errors.
• If you’re stuck, you can always reach us through the community slack.