Skip to content

API klíče

API klíče slouží k autentizaci požadavků na REST API bez uživatelské relace.

Každý API klíč je vázán na účet tenantu, který ho vytvořil. API klíče mají stejný přístup jako člen týmu - mohou číst a zapisovat všechna data tenantu, ale nemohou měnit fakturaci ani nastavení tarifu.

Seznam API klíčů

Vrací všechny aktivní API klíče pro tenant.

GET /tenants/me/api-keys

INFO

Z bezpečnostních důvodů je plná hodnota klíče vrácena pouze jednou - při vytvoření. Následné požadavky na seznam zobrazují pouze prefix klíče a metadata.

Příklad požadavku

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

Příklad odpovědi

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"
    }
  ]
}

Pole odpovědi

PoleTypPopis
idstringIdentifikátor klíče
namestringZobrazovaný název
prefixstringPrvních 12 znaků klíče (pro identifikaci)
createdAtstringČasové razítko ISO 8601
lastUsedAtstring nebo nullČasové razítko ISO 8601 posledního autentizovaného požadavku

Vytvoření API klíče

Vytvoří nový API klíč. Plná hodnota klíče je vrácena jednou a nelze ji znovu získat.

POST /tenants/me/api-keys

Tělo požadavku

json
{
  "name": "CI pipeline"
}
PoleTypPovinnéPopis
namestringAnoZobrazovaný název klíče

Příklad požadavku

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"}'

Příklad odpovědi

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
  }
}

Ihned uložte klíč

Pole key je vráceno pouze v této odpovědi. Nelze ho získat později. Ihned ho uložte do správce tajných údajů (GitHub Actions secrets, HashiCorp Vault apod.).


Smazání API klíče

Trvale odvolá API klíč. Jakékoli požadavky používající tento klíč okamžitě vrátí 401.

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

Příklad požadavku

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

Příklad odpovědi

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

Použití API klíče

Předejte API klíč jako Bearer token v hlavičce Authorization:

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

API klíče fungují stejně jako tokeny relací pro všechny endpointy. Nemají expiraci, ale můžete je rotovat vytvořením nového klíče a smazáním starého.

Limity požadavků

API je omezeno na 120 požadavků za minutu na API klíč. Požadavky překračující limit obdrží odpověď 429 Too Many Requests. Odpověď obsahuje hlavičku Retry-After udávající, kdy můžete zkusit znovu.

Byla tato stránka užitečná?