Skip to content

API kulcsok

Az API kulcsok a REST API kérések hitelesítésére szolgálnak felhasználói munkamenet nélkül.

Minden API kulcs ahhoz a bérlő fiókhoz van kötve, amely létrehozta. Az API kulcsok a csapattagokkal megegyező hozzáféréssel rendelkeznek - olvashatnak és írhatnak minden bérlő adatot, de nem változtathatnak számlázási vagy csomagbeállításokon.

API kulcsok listázása

Az összes aktív API kulcsot adja vissza a bérlőhöz.

GET /tenants/me/api-keys

INFO

Biztonsági okokból a teljes kulcsértéket csak egyszer adjuk vissza - a létrehozás pillanatában. A későbbi listázási kérések csak a kulcs prefixet és metaadatokat jelenítik meg.

Példa kérés

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

Példa válasz

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

Válasz mezők

MezőTípusLeírás
idstringKulcs-azonosító
namestringMegjelenítési név
prefixstringA kulcs első 12 karaktere (azonosításhoz)
createdAtstringISO 8601 időbélyeg
lastUsedAtstring vagy nullAz utolsó hitelesített kérés ISO 8601 időbélyegje

API kulcs létrehozása

Új API kulcsot hoz létre. A teljes kulcsértéket egyszer adja vissza, és nem kérdezhető le újra.

POST /tenants/me/api-keys

Kéréstörzs

json
{
  "name": "CI pipeline"
}
MezőTípusKötelezőLeírás
namestringIgenA kulcs megjelenítési neve

Példa kérés

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élda válasz

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

Mentsd el a kulcsot azonnal

A key mező kizárólag ebben a válaszban kerül visszaadásra. Később nem kérdezhető le. Tárold titokkezelőben (GitHub Actions secrets, HashiCorp Vault stb.) azonnal.


API kulcs törlése

Véglegesen visszavonja az API kulcsot. A kulcsot használó bármely kérésre azonnal 401 hiba válaszol.

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

Példa kérés

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

Példa válasz

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

API kulcs használata

Add át az API kulcsot Bearer tokenként az Authorization fejlécben:

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

Az API kulcsok minden végponton ugyanúgy működnek, mint a munkamenet tokenek. Nem járnak le, de rotálhatod őket új kulcs létrehozásával és a régi törlésével.

Sebességkorlátozás

Az API percenként 120 kérésre korlátozott API kulcsonként. A korlátot meghaladó kérések 429 Too Many Requests választ kapnak. A válasz tartalmaz egy Retry-After fejlécet, amely jelzi, mikor próbálhatod újra.

Hasznos volt ez az oldal?