API-avaimet

Ylläpitäjä: Aether365-tiimi Kohderyhmä: Kehittäjät Laajuus: API-avainten hallintapäätepisteet

API-avaimilla todennetaan REST API -pyynnöt ilman käyttäjäistuntoa.

Jokainen API-avain on sidottu sen luoneeseen vuokralaistiliin. API-avaimilla on sama käyttöoikeustaso kuin tiimijäsenellä - ne voivat lukea ja kirjoittaa kaikkia vuokralaisen tietoja mutta eivät voi muuttaa laskutusta tai suunnitelma-asetuksia.

Listaa API-avaimet

Palauttaa kaikki vuokralaisen aktiiviset API-avaimet.

GET /tenants/me/api-keys

INFO

Turvallisuussyistä täydellinen avainarvo palautetaan vain kerran - luontihetkellä. Myöhemmät listauspyynnöt näyttävät vain avaimen etuliitteen ja metatiedot.

Esimerkkipyyntö

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

Esimerkkivastaus

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

Vastauksen kentät

Kenttä	Tyyppi	Kuvaus
id	string	Avaimen tunniste
name	string	Näyttönimi
prefix	string	Avaimen 12 ensimmäistä merkkiä (tunnistusta varten)
createdAt	string	ISO 8601 -aikaleima
lastUsedAt	string tai null	ISO 8601 -aikaleima viimeisestä todennetusta pyynnöstä

---

Luo API-avain

Luo uuden API-avaimen. Täydellinen avainarvo palautetaan kerran eikä sitä voi hakea myöhemmin.

POST /tenants/me/api-keys

Pyynnön runko

{
  "name": "CI pipeline"
}

Kenttä	Tyyppi	Pakollinen	Kuvaus
name	string	Kyllä	Avaimen näyttönimi

Esimerkkipyyntö

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

Esimerkkivastaus

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

Tallenna avain välittömästi

key-kenttä palautetaan vain tässä vastauksessa. Sitä ei voi hakea myöhemmin. Tallenna se salaisuuksien hallintaan (GitHub Actions secrets, HashiCorp Vault jne.) välittömästi.

---

Poista API-avain

Peruuttaa pysyvästi API-avaimen. Kaikki tätä avainta käyttävät pyynnöt palauttavat 401 välittömästi.

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

Esimerkkipyyntö

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

Esimerkkivastaus

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

---

API-avaimen käyttäminen

Välitä API-avain Bearer-tokenina Authorization-otsikossa:

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

API-avaimet toimivat samalla tavalla kuin istuntotokenit kaikissa päätepisteissä. Ne eivät vanhene, mutta voit kierrättää niitä luomalla uuden avaimen ja poistamalla vanhan.

Nopeusrajoitukset

API:n nopeusrajoitus on 120 pyyntöä minuutissa per API-avain. Rajan ylittävät pyynnöt saavat 429 Too Many Requests -vastauksen. Vastaus sisältää Retry-After-otsikon, joka ilmoittaa milloin voit yrittää uudelleen.