API võtmed

API võtmeid kasutatakse REST API päringute autentimiseks ilma kasutajaseansita.

Iga API võti on seotud selle loonud halduskeskkonna kontoga. API võtmetel on sama juurdepääs kui meeskonnaliikmel - nad saavad lugeda ja kirjutada kõiki halduskeskkonna andmeid, kuid ei saa muuta arveldust ega plaani sätteid.

API võtmete loetelu

Tagastab kõik halduskeskkonna aktiivsed API võtmed.

GET /tenants/me/api-keys

INFO

Turvakaalutlustel tagastatakse võtme täisväärtus ainult üks kord - loomise ajal. Hilisemad loetelu päringud näitavad ainult võtme prefiksit ja metaandmeid.

Näidispäring

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

Näidisvastus

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

Vastuse väljad

Väli	Tüüp	Kirjeldus
id	string	Võtme identifikaator
name	string	Kuvatav nimi
prefix	string	Võtme esimesed 12 tähemärki (tuvastamiseks)
createdAt	string	ISO 8601 ajatempel
lastUsedAt	string või null	Viimase autenditud päringu ISO 8601 ajatempel

---

API võtme loomine

Loob uue API võtme. Võtme täisväärtus tagastatakse ainult üks kord ja seda ei saa hiljem uuesti kätte saada.

POST /tenants/me/api-keys

Päringu keha

{
  "name": "CI pipeline"
}

Väli	Tüüp	Nõutav	Kirjeldus
name	string	Jah	Võtme kuvatav nimi

Näidispäring

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

Näidisvastus

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

Salvestage võti kohe

Väli key tagastatakse ainult selles vastuses. Seda ei saa hiljem uuesti kätte saada. Salvestage see kohe saladuste haldusse (GitHub Actions secrets, HashiCorp Vault jne).

---

API võtme kustutamine

Tühistab API võtme jäädavalt. Kõik seda võtit kasutavad päringud tagastavad kohe 401.

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

Näidispäring

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

Näidisvastus

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

---

API võtme kasutamine

Edastage API võti Bearer tokenina Authorization päises:

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

API võtmed töötavad kõigi lõpp-punktide jaoks samamoodi nagu seansi tokenid. Need ei aegu, kuid saate neid roteerida, luues uue võtme ja kustutades vana.

Kiirusepiirangud

API-l on kiirusepiirang 120 päringut minutis API võtme kohta. Kiirusepiirangu ületavad päringud saavad vastuse 429 Too Many Requests. Vastus sisaldab Retry-After päist, mis näitab, millal saate uuesti proovida.