Skip to content

API kľúče

API kľúče slúžia na autentifikáciu požiadaviek na REST API bez používateľskej relácie.

Každý API kľúč je viazaný na účet tenantu, ktorý ho vytvoril. API kľúče majú rovnaký prístup ako člen tímu - môžu čítať a zapisovať všetky dáta tenantu, ale nemôžu meniť fakturáciu ani nastavenia plánu.

Zoznam API kľúčov

Vráti všetky aktívne API kľúče pre daného tenanta.

GET /tenants/me/api-keys

INFO

Z bezpečnostných dôvodov sa úplná hodnota kľúča vráti iba raz - pri vytvorení. Následné výpisy zobrazujú iba prefix kľúča a metadáta.

Príklad požiadavky

bash
curl https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>"

Príklad odpovede

json
{
  "success": true,
  "data": [
    {
      "id": "key_abc123",
      "name": "CI pipeline",
      "prefix": "ae_live_abc1",
      "createdAt": "2026-03-01T09:00:00Z",
      "lastUsedAt": "2026-04-10T14:23:00Z"
    }
  ]
}

Polia odpovede

PoleTypPopis
idstringIdentifikátor kľúča
namestringZobrazovaný názov
prefixstringPrvých 12 znakov kľúča (na identifikáciu)
createdAtstringČasová pečiatka ISO 8601
lastUsedAtstring alebo nullČasová pečiatka ISO 8601 poslednej autentifikovanej požiadavky

Vytvorenie API kľúča

Vytvorí nový API kľúč. Úplná hodnota kľúča sa vráti iba raz a nie je ju možné získať znova.

POST /tenants/me/api-keys

Telo požiadavky

json
{
  "name": "CI pipeline"
}
PoleTypPovinnéPopis
namestringÁnoZobrazovaný názov kľúča

Príklad požiadavky

bash
curl -X POST https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "CI pipeline"}'

Príklad odpovede

json
{
  "success": true,
  "data": {
    "id": "key_abc123",
    "name": "CI pipeline",
    "key": "ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "prefix": "ae_live_abc1",
    "createdAt": "2026-04-12T10:00:00Z",
    "lastUsedAt": null
  }
}

Kľúč si ihneď uložte

Pole key sa vracia iba v tejto odpovedi. Neskôr ho nie je možné získať. Uložte ho ihneď do správcu tajomstiev (GitHub Actions secrets, HashiCorp Vault atď.).


Vymazanie API kľúča

Natrvalo odvolá API kľúč. Všetky požiadavky používajúce tento kľúč okamžite dostanú odpoveď 401.

DELETE /tenants/me/api-keys/{keyId}

Príklad požiadavky

bash
curl -X DELETE https://api.aether365.io/tenants/me/api-keys/key_abc123 \
  -H "Authorization: Bearer <token>"

Príklad odpovede

json
{
  "success": true,
  "data": null
}

Použitie API kľúča

API kľúč odošlite ako Bearer token v hlavičke Authorization:

bash
curl https://api.aether365.io/tenants/me/scans \
  -H "Authorization: Bearer ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

API kľúče fungujú rovnako ako tokeny relácie pre všetky koncové body. Nevypršia, ale môžete ich rotovať vytvorením nového kľúča a vymazaním starého.

Limity rýchlosti

API je limitované na 120 požiadaviek za minútu na jeden API kľúč. Požiadavky prekračujúce limit dostanú odpoveď 429 Too Many Requests. Odpoveď obsahuje hlavičku Retry-After udávajúcu, kedy môžete opakovať požiadavku.

Bola táto stránka užitočná?